# base URL: /api/rendering/plugins/directives/base/ Section: directives -------------------------------------------------------------------------------- base - 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.base Base class for Bengal directives. Provides BengalDirective as the foundation for all directive implementations, offering automatic registration, typed options, contract validation, and encapsulated rendering. Architecture: BengalDirective extends mistune's DirectivePlugin with: Automatic directive and renderer registration via NAMES/TOKEN_TYPE Typed option parsing via OPTIONS_CLASS Nesting validation via CONTRACT Template method pattern for parse flow Encapsulated render method Related: bengal/rendering/plugins/directives/tokens.py: DirectiveToken bengal/rendering/plugins/directives/options.py: DirectiveOptions bengal/rendering/plugins/directives/contracts.py: DirectiveContract RFC: plan/active/rfc-directive-system-v2.md View source 1 Class Classes BengalDirective Base class for Bengal directives with nesting validation. Provides: - Automatic directive and rend… 12 Caret Right Base class for Bengal directives with nesting validation. Provides: Automatic directive and renderer registration Typed option parsing via OPTIONS_CLASS Contract validation for parent-child relationships Shared utility methods (escape_html, build_class_string) Consistent type hints and logging Subclass Requirements: NAMES: List of directive names to register (e.g., ["dropdown", "details"]) TOKEN_TYPE: Token type string for AST (e.g., "dropdown") OPTIONS_CLASS: (optional) Typed options dataclass CONTRACT: (optional) Nesting validation contract parse_directive(): Build token from parsed components render(): Render token to HTML Inherits from DirectivePlugin Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] CONTRACT ClassVar[DirectiveContract | None] Methods 6 parse Standard parse flow with contract validation. Validation steps: 1. Validate pa… 3 dict[str, Any] Caret Right def parse(self, block: Any, m: Match[str], state: Any) -> dict[str, Any] Standard parse flow with contract validation. Validation steps: Validate parent context (if CONTRACT.requires_parent) Parse content and children Validate children (if CONTRACT.requires_children) Override parse_directive() instead of this method for most cases. Override this method only if you need custom pre/post processing. Parameters 3 block Any Mistune block parser instance m Match[str] Regex match object from directive pattern state Any Parser state Returns dict[str, Any] — Token dict for mistune AST parse_directive Build the token from parsed components. Override this method to implement dire… 5 DirectiveToken | di… Caret Right def parse_directive(self, title: str, options: DirectiveOptions, content: str, children: list[Any], state: Any) -> DirectiveToken | dict[str, Any] Build the token from parsed components. Override this method to implement directive-specific logic. Parameters 5 title str Directive title (text after directive name) options DirectiveOptions Parsed and typed options content str Raw content string (rarely needed, use children) children list[Any] Parsed nested content tokens state Any Parser state (for accessing heading levels, etc.) Returns DirectiveToken | dict[str, Any] — DirectiveToken or dict for AST render Render token to HTML. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render token to HTML. Parameters 2 renderer Any Mistune renderer instance text str Pre-rendered children HTML **attrs: Token attributes Returns str — HTML string escape_html staticmethod Escape HTML special characters for use in attributes. Escapes: & < > " ' 1 str Caret Right def escape_html(text: str) -> str Escape HTML special characters for use in attributes. Escapes: & < > " ' Parameters 1 text str Raw text to escape Returns str — HTML-escaped text build_class_string staticmethod Build CSS class string from multiple class sources. Filters out empty strings … 0 str Caret Right def build_class_string(*classes: str) -> str Build CSS class string from multiple class sources. Filters out empty strings and joins with space. Returns str — Space-joined class string bool_attr staticmethod Return HTML boolean attribute string. 2 str Caret Right def bool_attr(name: str, value: bool) -> str Return HTML boolean attribute string. Parameters 2 name str Attribute name (e.g., "open") value bool Whether to include the attribute Returns str — " name" if value is True, "" otherwise Internal Methods 6 Caret Right __init__ Initialize directive with logger. 0 None Caret Right def __init__(self) -> None Initialize directive with logger. _get_parent_directive_type Extract parent directive type from parser state. Mistune tracks directive nest… 1 str | None Caret Right def _get_parent_directive_type(self, state: Any) -> str | None Extract parent directive type from parser state. Mistune tracks directive nesting in state. This method extracts the immediate parent directive type for contract validation. Parameters 1 state Any Parser state Returns str | None — Parent directive type (e.g., "steps") or None if at root _push_directive_stack Push current directive onto the stack for child validation. 2 None Caret Right def _push_directive_stack(self, state: Any, directive_type: str) -> None Push current directive onto the stack for child validation. Parameters 2 state Any Parser state directive_type str Current directive type _pop_directive_stack Pop current directive from the stack. 1 None Caret Right def _pop_directive_stack(self, state: Any) -> None Pop current directive from the stack. Parameters 1 state Any Parser state _get_source_location Extract source file location from parser state. 1 str | None Caret Right def _get_source_location(self, state: Any) -> str | None Extract source file location from parser state. Parameters 1 state Any Parser state Returns str | None — Location string like "content/guide.md:45" or None __call__ Register directive names and renderer. Override only if you need custom regist… 2 None Caret Right def __call__(self, directive: Any, md: Any) -> None Register directive names and renderer. Override only if you need custom registration logic (e.g., multiple token types like AdmonitionDirective). Parameters 2 directive Any Mistune directive registry md Any Mistune Markdown instance ← Previous badge Next → button 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: 1753 - Reading Time: 9 minutes