# metadata URL: /api/core/page/metadata/ Section: page -------------------------------------------------------------------------------- metadata - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Core Page ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module core.page.metadata Page Metadata Mixin - Basic properties and type checking. View source 1 Class Classes PageMetadataMixin Mixin providing metadata properties and type checking for pages. This mixin handles: - Basic prope… 27 Caret Right Mixin providing metadata properties and type checking for pages. This mixin handles: Basic properties: title, date, slug, url Type checking: is_home, is_section, is_page, kind Simple metadata: description, draft, keywords Component Model: type, variant, props TOC access: toc_items (lazy evaluation) Attributes Name Type Description metadata dict[str, Any] source_path Path output_path Path | None toc str | None core PageCore | None _site Any _toc_items_cache list[dict[str, Any]] | None Methods 26 Tag title property Get page title from metadata or generate intelligently from context. For index… str Caret Right def title(self) -> str Get page title from metadata or generate intelligently from context. For index pages (_index.md or index.md) without explicit titles, uses the parent directory name humanized instead of showing "Index" which is not user-friendly in menus, navigation, or page titles. Returns str Tag date property Get page date from metadata. Uses bengal.utils.dates.parse_date for flexible d… datetime | None Caret Right def date(self) -> datetime | None Get page date from metadata. Uses bengal.utils.dates.parse_date for flexible date parsing. Returns datetime | None Tag slug property Get URL slug for the page. str Caret Right def slug(self) -> str Get URL slug for the page. Returns str Tag relative_url property Get relative URL without baseurl (for comparisons). This is the identity URL -… str Caret Right def relative_url(self) -> str Get relative URL without baseurl (for comparisons). This is the identity URL - use for comparisons, menu activation, etc. Always returns a relative path without baseurl. Returns str Tag url property Get URL with baseurl applied (cached after first access). This is the primary … str Caret Right def url(self) -> str Get URL with baseurl applied (cached after first access). This is the primary URL property for templates - automatically includes baseurl when available. Use .relative_url for comparisons. Returns str — URL path with baseurl prepended (if configured) Tag permalink property Alias for url (for backward compatibility). Both url and permalink now return … str Caret Right def permalink(self) -> str Alias for url (for backward compatibility). Both url and permalink now return the same value (with baseurl). Use .relative_url for comparisons. Returns str Tag toc_items property Get structured TOC data (lazy evaluation). Only extracts TOC structure when ac… list[dict[str, Any]] Caret Right def toc_items(self) -> list[dict[str, Any]] Get structured TOC data (lazy evaluation). Only extracts TOC structure when accessed by templates, saving HTMLParser overhead for pages that don't use toc_items. Important: This property does NOT cache empty results. This allows toc_items to be accessed before parsing (during xref indexing) without preventing extraction after parsing when page.toc is actually set. Returns list[dict[str, Any]] — List of TOC items with id, title, and level Tag is_home property Check if this page is the home page. bool Caret Right def is_home(self) -> bool Check if this page is the home page. Returns bool — True if this is the home page Tag is_section property Check if this page is a section page. bool Caret Right def is_section(self) -> bool Check if this page is a section page. Returns bool — True if this is a section (always False for Page, True for Section) Tag is_page property Check if this is a regular page (not a section). bool Caret Right def is_page(self) -> bool Check if this is a regular page (not a section). Returns bool — True if this is a regular page Tag kind property Get the kind of page: 'home', 'section', or 'page'. str Caret Right def kind(self) -> str Get the kind of page: 'home', 'section', or 'page'. Returns str — String indicating page kind Tag type property Get page type from core metadata (preferred) or frontmatter. Component Model: … str | None Caret Right def type(self) -> str | None Get page type from core metadata (preferred) or frontmatter. Component Model: Identity. Returns str | None — Page type or None Tag description property Get page description from core metadata (preferred) or frontmatter. str Caret Right def description(self) -> str Get page description from core metadata (preferred) or frontmatter. Returns str — Page description or empty string Tag variant property Get visual variant from core (preferred) or legacy layout/hero_style fields. T… str | None Caret Right def variant(self) -> str | None Get visual variant from core (preferred) or legacy layout/hero_style fields. This normalizes 'layout' and 'hero_style' into the new Component Model 'variant'. Component Model: Mode. Returns str | None — Variant string or None Tag props property Get page props (alias for metadata). Component Model: Data. dict[str, Any] Caret Right def props(self) -> dict[str, Any] Get page props (alias for metadata). Component Model: Data. Returns dict[str, Any] — Page metadata dictionary Tag draft property Check if page is marked as draft. bool Caret Right def draft(self) -> bool Check if page is marked as draft. Returns bool — True if page is a draft Tag keywords property Get page keywords from metadata. list[str] Caret Right def keywords(self) -> list[str] Get page keywords from metadata. Returns list[str] — List of keywords Tag hidden property Check if page is hidden (unlisted). Hidden pages: - Are excluded from navigati… bool Caret Right def hidden(self) -> bool Check if page is hidden (unlisted). Hidden pages: Are excluded from navigation menus Are excluded from site.pages queries (listings) Are excluded from sitemap.xml Get noindex,nofollow robots meta Still render and are accessible via direct URL Returns bool — True if page is hidden Tag visibility property Get visibility settings with defaults. The visibility object provides granular… dict[str, Any] Caret Right def visibility(self) -> dict[str, Any] Get visibility settings with defaults. The visibility object provides granular control over page visibility: menu: Include in navigation menus (default: True) listings: Include in site.pages queries (default: True) sitemap: Include in sitemap.xml (default: True) robots: Robots meta directive (default: "index, follow") render: When to render - "always", "local", "never" (default: "always") search: Include in search index (default: True) rss: Include in RSS feeds (default: True) If hidden: true is set, it expands to restrictive defaults. Returns dict[str, Any] — Dict with visibility settings Tag in_listings property Check if page should appear in listings/queries. Excludes drafts and pages wit… bool Caret Right def in_listings(self) -> bool Check if page should appear in listings/queries. Excludes drafts and pages with visibility.listings=False. Returns bool — True if page should appear in site.pages queries Tag in_sitemap property Check if page should appear in sitemap. Excludes drafts and pages with visibil… bool Caret Right def in_sitemap(self) -> bool Check if page should appear in sitemap. Excludes drafts and pages with visibility.sitemap=False. Returns bool — True if page should appear in sitemap.xml Tag in_search property Check if page should appear in search index. Excludes drafts and pages with vi… bool Caret Right def in_search(self) -> bool Check if page should appear in search index. Excludes drafts and pages with visibility.search=False. Returns bool — True if page should appear in search index Tag in_rss property Check if page should appear in RSS feeds. Excludes drafts and pages with visib… bool Caret Right def in_rss(self) -> bool Check if page should appear in RSS feeds. Excludes drafts and pages with visibility.rss=False. Returns bool — True if page should appear in RSS feeds Tag robots_meta property Get robots meta content for this page. str Caret Right def robots_meta(self) -> str Get robots meta content for this page. Returns str — Robots directive string (e.g., "index, follow" or "noindex, nofollow") Tag should_render property Check if page should be rendered based on visibility.render setting. Note: Thi… bool Caret Right def should_render(self) -> bool Check if page should be rendered based on visibility.render setting. Note: This checks the render setting but doesn't know about environment. Use should_render_in_environment() for environment-aware checks. Returns bool — True if render is not "never" should_render_in_environment Check if page should be rendered in the given environment. 1 bool Caret Right def should_render_in_environment(self, is_production: bool = False) -> bool Check if page should be rendered in the given environment. Parameters 1 is_production bool True if building for production Returns bool — True if page should be rendered in this environment Internal Methods 1 Caret Right _fallback_url Generate fallback URL when output_path or site not available. Used during page… 0 str Caret Right def _fallback_url(self) -> str Generate fallback URL when output_path or site not available. Used during page construction before output_path is determined. Returns str — URL based on slug ← Previous content Next → navigation List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 2342 - Reading Time: 12 minutes