# core URL: /api/rendering/template_engine/core/ Section: template_engine -------------------------------------------------------------------------------- core - 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 Rendering Template Engine ᗢ 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.template_engine.core Template engine using Jinja2 for page rendering. Provides template rendering, template function registration, and optional template profiling for performance analysis. Integrates with theme system for template discovery and asset manifest for cache-busting. Key Concepts: Template inheritance: Child themes inherit parent templates Bytecode caching: Compiled templates cached for faster subsequent renders Template profiling: Optional timing data collection via --profile-templates Strict mode: StrictUndefined enabled for better error detection Related Modules: bengal.rendering.template_profiler: Profiling implementation bengal.rendering.template_functions: Template function registry bengal.utils.theme_registry: Theme resolution and discovery View source 1 Class Classes TemplateEngine Template engine for rendering pages with Jinja2 templates. Provides Jinja2 template rendering with… 10 Caret Right Template engine for rendering pages with Jinja2 templates. Provides Jinja2 template rendering with theme inheritance, template function registration, asset manifest access, and optional template profiling. Manages template discovery through theme chains and provides cache-busting via asset manifest. Creation: Direct instantiation: TemplateEngine(site, profile_templates=False) Created by RenderingPipeline for template rendering Requires Site instance with theme configuration Optional profiling enabled via profile_templates flag Inherits from MenuHelpersMixin, ManifestHelpersMixin, AssetURLMixin Attributes Name Type Description site — Site instance with theme and configuration template_dirs — List of template directories (populated during init) env — Jinja2 Environment instance _profile_templates — Whether template profiling is enabled _profiler — Optional TemplateProfiler for performance analysis _dependency_tracker — Optional DependencyTracker (set by RenderingPipeline) _asset_manifest_cache — Cached asset manifest entries Relationships — Uses: Theme resolution for template directory discovery - Uses: Template functions for template function registration - Uses: AssetManifest for cache-busting asset URLs - Used by: RenderingPipeline for template rendering - Used by: Renderer for page rendering Methods 4 render Render a template with the given context. 2 str Caret Right def render(self, template_name: str, context: dict[str, Any]) -> str Render a template with the given context. Parameters 2 template_name str Name of the template file context dict[str, Any] Template context variables Returns str — Rendered HTML get_template_profile Get template profiling report. 0 dict[str, Any] | None Caret Right def get_template_profile(self) -> dict[str, Any] | None Get template profiling report. Returns dict[str, Any] | None — Dictionary with template and function timing statistics, or None if profiling is not enabled. render_string Render a template string with the given context. 2 str Caret Right def render_string(self, template_string: str, context: dict[str, Any]) -> str Render a template string with the given context. Parameters 2 template_string str Template content as string context dict[str, Any] Template context variables Returns str — Rendered HTML validate_templates Validate syntax of all templates in the search path. Proactively checks all di… 1 list[Any] Caret Right def validate_templates(self, include_patterns: list[str] | None = None) -> list[Any] Validate syntax of all templates in the search path. Proactively checks all discoverable templates for syntax errors by attempting to compile them through Jinja2. This catches errors before rendering, providing early feedback during builds. Parameters 1 include_patterns list[str] | None Optional list of glob patterns to limit validation (e.g., ["page.html", "partials/*.html"]). If None, validates all .html and .xml templates. Returns list[Any] — List of TemplateRenderError for any templates with syntax errors. Empty list if all templates are valid. Internal Methods 6 Caret Right __init__ Initialize the template engine. 2 None Caret Right def __init__(self, site: Any, profile_templates: bool = False) -> None Initialize the template engine. Parameters 2 site Any Site instance profile_templates bool Enable template profiling for performance analysis _url_for Generate URL for a page with base URL support. 1 str Caret Right def _url_for(self, page: Any) -> str Generate URL for a page with base URL support. Parameters 1 page Any Page object Returns str — URL path with base URL prefix if configured _with_baseurl Apply base URL prefix to a path. 1 str Caret Right def _with_baseurl(self, path: str) -> str Apply base URL prefix to a path. Parameters 1 path str Relative path starting with '/' Returns str — Path with base URL prefix _find_template_path Find the full path to a template file. 1 Path | None Caret Right def _find_template_path(self, template_name: str) -> Path | None Find the full path to a template file. Parameters 1 template_name str Name of the template Returns Path | None — Full path to template file, or None if not found _resolve_theme_chain Resolve theme inheritance chain starting from the active theme. Compatibility … 1 list[str] Caret Right def _resolve_theme_chain(self, active_theme: str | None) -> list[str] Resolve theme inheritance chain starting from the active theme. Compatibility method for tests. Delegates to resolve_theme_chain function. Parameters 1 active_theme str | None Active theme name Returns list[str] — List of theme names in inheritance order _read_theme_extends Read theme.toml for 'extends' value. Compatibility method for tests. Delegates… 1 str | None Caret Right def _read_theme_extends(self, theme_name: str) -> str | None Read theme.toml for 'extends' value. Compatibility method for tests. Delegates to read_theme_extends function. Parameters 1 theme_name str Theme name to look up Returns str | None — Parent theme name if extends is set, None otherwise ← Previous asset_url Next → environment 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: 1731 - Reading Time: 9 minutes