# discovery URL: /api/core/site/discovery/ Section: site -------------------------------------------------------------------------------- discovery - 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 Site ᗢ 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.site.discovery Content discovery mixin for Site. Provides methods for discovering content (pages, sections) and assets, and setting up page/section references. Related Modules: bengal.core.site.core: Main Site dataclass using this mixin bengal.discovery.content_discovery: Content discovery implementation bengal.discovery.asset_discovery: Asset discovery implementation View source 1 Class Classes ContentDiscoveryMixin Mixin providing content and asset discovery methods. Requires these attributes on the host class: … 8 Caret Right Mixin providing content and asset discovery methods. Requires these attributes on the host class: root_path: Path config: dict[str, Any] pages: list[Page] sections: list[Section] assets: list[Asset] theme: str | None register_sections: Callable (from SectionRegistryMixin) _get_theme_assets_chain: Callable (from ThemeIntegrationMixin) Attributes Name Type Description root_path Path config dict[str, Any] pages list[Page] sections list[Section] assets list[Asset] theme str | None Methods 2 discover_content Discover all content (pages, sections) in the content directory. Scans the con… 1 None Caret Right def discover_content(self, content_dir: Path | None = None) -> None Discover all content (pages, sections) in the content directory. Scans the content directory recursively, creating Page and Section objects for all markdown files and organizing them into a hierarchy. Parameters 1 content_dir Path | None Content directory path (defaults to root_path/content) discover_assets Discover all assets in the assets directory and theme assets. Scans both theme… 1 None Caret Right def discover_assets(self, assets_dir: Path | None = None) -> None Discover all assets in the assets directory and theme assets. Scans both theme assets (from theme inheritance chain) and site assets (from assets/ directory). Theme assets are discovered first (lower priority), then site assets (higher priority, can override theme assets). Assets are deduplicated by output path with site assets taking precedence. Parameters 1 assets_dir Path | None Assets directory path (defaults to root_path/assets). If None, uses site root_path / "assets" Internal Methods 6 Caret Right _get_theme_assets_chain Get theme assets paths in inheritance order (from ThemeIntegrationMixin). 0 list[Path] Caret Right def _get_theme_assets_chain(self) -> list[Path] Get theme assets paths in inheritance order (from ThemeIntegrationMixin). Returns list[Path] _setup_page_references Set up page references for navigation (next, prev, parent, etc.). Sets _site a… 0 None Caret Right def _setup_page_references(self) -> None Set up page references for navigation (next, prev, parent, etc.). Sets _site and _section references on all pages to enable navigation properties. Must be called after content discovery and section registry building, but before cascade application. Process: 1. Set _site reference on all pages (including top-level pages) 2. Set _site reference on all sections 3. Set _section reference on section index pages 4. Set _section reference on pages based on their location 5. Recursively process subsections Build Ordering Invariant: This method must be called after register_sections() to ensure the section registry is populated for virtual section URL lookups. Called By: discover_content() - Automatically called after content discovery _setup_section_references Recursively set up references for a section and its subsections. Sets _site re… 1 None Caret Right def _setup_section_references(self, section: Section) -> None Recursively set up references for a section and its subsections. Sets _site reference on subsections, _section reference on index pages, and _section reference on pages within subsections. Recursively processes all nested subsections. Parameters 1 section Section Section to set up references for (processes its subsections) Called By: _setup_page_references() - Called for each top-level section _validate_page_section_references Validate that pages in sections have correct _section references. Logs warning… 0 None Caret Right def _validate_page_section_references(self) -> None Validate that pages in sections have correct _section references. Logs warnings for pages that are in a section's pages list but have _section = None, which would cause navigation to fall back to flat mode. This validation catches bugs like the virtual section path=None issue described in plan/active/rfc-page-section-reference-contract.md. Called By: discover_content() - After _setup_page_references() _validate_subsection_references Recursively validate page-section references in subsections. 2 None Caret Right def _validate_subsection_references(self, section: Section, pages_without_section: list[tuple[Page, Section]]) -> None Recursively validate page-section references in subsections. Parameters 2 section Section Section to check subsections of pages_without_section list[tuple[Page, Section]] List to append (page, expected_section) tuples to _apply_cascades Apply cascading metadata from sections to their child pages and subsections. S… 0 None Caret Right def _apply_cascades(self) -> None Apply cascading metadata from sections to their child pages and subsections. Section _index.md files can define metadata that automatically applies to all descendant pages. This allows setting common metadata (like type, version, or visibility) at the section level rather than repeating it on every page. Cascade metadata is defined in a section's _index.md frontmatter: ← Previous data Next → factories 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: 1638 - Reading Time: 8 minutes