# lunr_index_generator URL: /api/postprocess/output_formats/lunr_index_generator/ Section: output_formats -------------------------------------------------------------------------------- lunr_index_generator - 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 Postprocess Output Formats ᗢ 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 postprocess.output_formats.lunr_index_generator Pre-built Lunr.js search index generator for Bengal SSG. Generates a serialized Lunr index at build time using the Python lunr package, enabling faster client-side search by avoiding runtime index construction. The pre-built index is written to search-index.json alongside index.json. Client-side search.js loads the pre-built index via lunr.Index.load() instead of rebuilding from raw page data on every page load. Configuration: search: lunr: prebuilt: true # Enable pre-built index (default: true) Performance Impact: Build time: +5-10s for index pre-building Runtime: ~50% faster initial search (no client-side index build) Index size: ~60% smaller (pre-built is more compact) Related: index_generator.py: Source of page data (index.json) search.js: Client-side search using pre-built or runtime index View source 1 Class Classes LunrIndexGenerator Generate pre-built Lunr.js search index at build time. Uses the Python `lunr` package (pure Python… 8 Caret Right Generate pre-built Lunr.js search index at build time. Uses the Python lunr package (pure Python implementation of Lunr.js) to build a serialized search index that can be loaded directly by the client-side Lunr.js library. Field Boosts (matching search.js): title: 10x (most important) search_keywords: 8x (explicit search terms) description: 5x (page summary) tags: 3x (categorization) section: 2x (content organization) author: 2x (authorship) content: 1x (full text) kind: 1x (content type) Methods 2 is_available Check if the lunr Python package is available. 0 bool Caret Right def is_available(self) -> bool Check if the lunr Python package is available. Returns bool — True if lunr can be imported, False otherwise generate Generate pre-built Lunr index from index.json. 1 Path | None Caret Right def generate(self, index_json_path: Path | None = None) -> Path | None Generate pre-built Lunr index from index.json. Parameters 1 index_json_path Path | None Path to index.json. If None, uses default location. Returns Path | None — Path to the generated search-index.json, or None if generation failed. Internal Methods 6 Caret Right __init__ Initialize the Lunr index generator. 1 None Caret Right def __init__(self, site: Site) -> None Initialize the Lunr index generator. Parameters 1 site Site Site instance with rendered pages _build_documents Build document list for Lunr indexing. Filters out pages marked for exclusion … 1 list[dict[str, Any]] Caret Right def _build_documents(self, pages: list[dict[str, Any]]) -> list[dict[str, Any]] Build document list for Lunr indexing. Filters out pages marked for exclusion and transforms page data into the format expected by Lunr. Parameters 1 pages list[dict[str, Any]] List of page dictionaries from index.json Returns list[dict[str, Any]] — List of documents ready for Lunr indexing _get_author Extract author string from page data. 1 str Caret Right def _get_author(self, page: dict[str, Any]) -> str Extract author string from page data. Parameters 1 page dict[str, Any] Returns str _join_list Join list items into space-separated string. 1 str Caret Right def _join_list(self, items: list[str] | None) -> str Join list items into space-separated string. Parameters 1 items list[str] | None Returns str _get_index_json_path Get the path to index.json, handling i18n prefixes. 0 Path Caret Right def _get_index_json_path(self) -> Path Get the path to index.json, handling i18n prefixes. Returns Path _get_output_path Get the output path for search-index.json, handling i18n prefixes. 0 Path Caret Right def _get_output_path(self) -> Path Get the output path for search-index.json, handling i18n prefixes. Returns Path ← Previous llm_generator Next → output_formats 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: 1446 - Reading Time: 7 minutes