# navigation URL: /api/rendering/plugins/directives/navigation/ Section: directives -------------------------------------------------------------------------------- navigation - 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 Plugins Directives ᗢ 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 rendering.plugins.directives.navigation Navigation directives for Bengal SSG. Provides directives that leverage the pre-computed site tree: breadcrumbs: Auto-generate breadcrumb navigation from page.ancestors siblings: Show other pages in the same section prev-next: Section-aware previous/next navigation related: Show related content based on tags Architecture: Migrated to BengalDirective base class as part of directive system v2. All directives access renderer._current_page to walk the object tree. View source 8 Classes 5 Functions Classes BreadcrumbsOptions dataclass Options for breadcrumbs directive. 0 Caret Right Options for breadcrumbs directive. Inherits from DirectiveOptions Attributes Name Type Description separator str Separator character between items (default: ›) show_home bool Whether to show home link (default: true) home_text str Text for home link (default: Home) home_url str URL for home link (default: /) _field_aliases ClassVar[dict[str, str]] BreadcrumbsDirective Auto-generate breadcrumb navigation from page ancestors. Syntax: :::{breadcrumbs} :separat… 2 Caret Right Auto-generate breadcrumb navigation from page ancestors. Syntax: :::{breadcrumbs} :separator: / :show-home: true :home-text: Home ::: Inherits from BengalDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] Methods 2 parse_directive Build breadcrumbs token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: BreadcrumbsOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build breadcrumbs token. Parameters 5 title str options BreadcrumbsOptions content str children list[Any] state Any Returns DirectiveToken render Render breadcrumb navigation from page ancestors. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render breadcrumb navigation from page ancestors. Parameters 2 renderer Any text str Returns str SiblingsOptions dataclass Options for siblings directive. 0 Caret Right Options for siblings directive. Inherits from DirectiveOptions Attributes Name Type Description limit int Maximum number of siblings to show (0 = no limit) exclude_current bool Whether to exclude current page show_description bool Whether to show page descriptions _field_aliases ClassVar[dict[str, str]] SiblingsDirective Show other pages in the same section. Syntax: :::{siblings} :limit: 10 :exclude-curren… 2 Caret Right Show other pages in the same section. Syntax: :::{siblings} :limit: 10 :exclude-current: true :show-description: true ::: Inherits from BengalDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] Methods 2 parse_directive Build siblings token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: SiblingsOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build siblings token. Parameters 5 title str options SiblingsOptions content str children list[Any] state Any Returns DirectiveToken render Render sibling pages in the same section. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render sibling pages in the same section. Parameters 2 renderer Any text str Returns str PrevNextOptions dataclass Options for prev-next directive. 0 Caret Right Options for prev-next directive. Inherits from DirectiveOptions Attributes Name Type Description show_title bool Whether to show page titles show_section bool Whether to show section names _field_aliases ClassVar[dict[str, str]] PrevNextDirective Section-aware previous/next navigation. Syntax: :::{prev-next} :show-title: true :show… 2 Caret Right Section-aware previous/next navigation. Syntax: :::{prev-next} :show-title: true :show-section: false ::: Inherits from BengalDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] Methods 2 parse_directive Build prev-next token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: PrevNextOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build prev-next token. Parameters 5 title str options PrevNextOptions content str children list[Any] state Any Returns DirectiveToken render Render previous/next navigation links. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render previous/next navigation links. Parameters 2 renderer Any text str Returns str RelatedOptions dataclass Options for related directive. 0 Caret Right Options for related directive. Inherits from DirectiveOptions Attributes Name Type Description limit int Maximum number of related items (default: 5) title str Section title (default: Related Articles) show_tags bool Whether to show tags _field_aliases ClassVar[dict[str, str]] RelatedDirective Show related content based on tags. Syntax: :::{related} :limit: 5 :title: Related Art… 2 Caret Right Show related content based on tags. Syntax: :::{related} :limit: 5 :title: Related Articles :show-tags: true ::: Inherits from BengalDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] Methods 2 parse_directive Build related token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: RelatedOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build related token. Parameters 5 title str options RelatedOptions content str children list[Any] state Any Returns DirectiveToken render Render related content based on tags. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render related content based on tags. Parameters 2 renderer Any text str Returns str Functions _get_section_url Get URL for a section. 1 str Caret Right def _get_section_url(section: Any) -> str Get URL for a section. Parameters 1 Name Type Default Description section Any — Returns str render_breadcrumbs Legacy render function for backward compatibility. 2 str Caret Right def render_breadcrumbs(renderer: Any, text: str, **attrs: Any) -> str Legacy render function for backward compatibility. Parameters 2 Name Type Default Description renderer Any — text str — Returns str render_siblings Legacy render function for backward compatibility. 2 str Caret Right def render_siblings(renderer: Any, text: str, **attrs: Any) -> str Legacy render function for backward compatibility. Parameters 2 Name Type Default Description renderer Any — text str — Returns str render_prev_next Legacy render function for backward compatibility. 2 str Caret Right def render_prev_next(renderer: Any, text: str, **attrs: Any) -> str Legacy render function for backward compatibility. Parameters 2 Name Type Default Description renderer Any — text str — Returns str render_related Legacy render function for backward compatibility. 2 str Caret Right def render_related(renderer: Any, text: str, **attrs: Any) -> str Legacy render function for backward compatibility. Parameters 2 Name Type Default Description renderer Any — text str — Returns str ← Previous marimo Next → options 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: 1841 - Reading Time: 9 minutes