# dev_server URL: /api/server/dev_server/ Section: server -------------------------------------------------------------------------------- dev_server - 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 API Reference Server ᗢ 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 server.dev_server Development server with file watching and hot reload. View source 1 Class Classes DevServer Development server with file watching and auto-rebuild. Provides a complete development environmen… 11 Caret Right Development server with file watching and auto-rebuild. Provides a complete development environment for Bengal sites with: HTTP server for viewing the site locally File watching for automatic rebuilds Graceful shutdown handling Stale process detection and cleanup Automatic port fallback Optional browser auto-open The server performs an initial build, then watches for changes and automatically rebuilds only what's needed using incremental builds. Features: Incremental + parallel builds (5-10x faster than full builds) Beautiful, minimal request logging Custom 404 error pages PID file tracking for stale process detection Comprehensive resource cleanup on shutdown Methods 1 start Start the development server with robust resource cleanup. This method: 1. Che… 0 None Caret Right def start(self) -> None Start the development server with robust resource cleanup. This method: Checks for and handles stale processes Prepares dev-specific configuration Performs an initial build Creates HTTP server (with port fallback if needed) Starts file watcher (if enabled) Opens browser (if requested) Runs until interrupted (Ctrl+C, SIGTERM, etc.) The server uses ResourceManager for comprehensive cleanup handling, ensuring all resources are properly released on shutdown regardless of how the process exits. Internal Methods 10 Caret Right __init__ Initialize the dev server. 6 None Caret Right def __init__(self, site: Any, host: str = DEFAULT_DEV_HOST, port: int = DEFAULT_DEV_PORT, watch: bool = True, auto_port: bool = True, open_browser: bool = False) -> None Initialize the dev server. Parameters 6 site Any Site instance host str Server host port int Server port watch bool Whether to watch for file changes auto_port bool Whether to automatically find an available port if the specified one is in use open_browser bool Whether to automatically open the browser _prepare_dev_config Prepare site configuration for development mode. Sets development-specific def… 0 bool Caret Right def _prepare_dev_config(self) -> bool Prepare site configuration for development mode. Sets development-specific defaults: Disables asset fingerprinting (stable URLs for hot reload) Disables minification (faster rebuilds, easier debugging) Clears baseurl (serves from root '/' not subdirectory) When baseurl is cleared, also clears the build cache to prevent stale baseurl values from persisting in cached data. Returns bool — True if baseurl was cleared (requires clean rebuild) _get_watched_directories Get list of directories that will be watched. 0 list[str] Caret Right def _get_watched_directories(self) -> list[str] Get list of directories that will be watched. Returns list[str] — List of directory paths (as strings) that exist and will be watched _create_observer Create file system observer (does not start it). 1 Any Caret Right def _create_observer(self, actual_port: int) -> Any Create file system observer (does not start it). Parameters 1 actual_port int Port number to display in rebuild messages Returns Any — Configured Observer instance (not yet started) _is_port_available Check if a port is available for use. 1 bool Caret Right def _is_port_available(self, port: int) -> bool Check if a port is available for use. Parameters 1 port int Port number to check Returns bool — True if port is available, False otherwise _find_available_port Find an available port starting from the given port. 2 int Caret Right def _find_available_port(self, start_port: int, max_attempts: int = 10) -> int Find an available port starting from the given port. Parameters 2 start_port int Port to start searching from max_attempts int Maximum number of ports to try Returns int — Available port number _check_stale_processes Check for and offer to clean up stale processes. Looks for a PID file from a p… 0 None Caret Right def _check_stale_processes(self) -> None Check for and offer to clean up stale processes. Looks for a PID file from a previous Bengal server run. If found, verifies the process is actually a Bengal process and offers to terminate it gracefully. _create_server Create HTTP server (does not start it). Changes to the output directory and cr… 0 tuple[socketserver.… Caret Right def _create_server(self) -> tuple[socketserver.ThreadingTCPServer, int] Create HTTP server (does not start it). Changes to the output directory and creates a TCP server on the specified port. If the port is unavailable and auto_port is enabled, automatically finds the next available port. Returns tuple[socketserver.ThreadingTCPServer, int] — Tuple of (httpd, actual_port) where httpd is the TCPServer instance and actual_port is the port it's bound to _print_startup_message Print server startup message using Rich for stable borders. Displays a beautif… 1 None Caret Right def _print_startup_message(self, port: int) -> None Print server startup message using Rich for stable borders. Displays a beautiful panel with: Server URL Output directory being served File watching status Shutdown instructions Parameters 1 port int Port number the server is listening on _open_browser_delayed Open browser after a short delay (in background thread). Uses a background thr… 1 None Caret Right def _open_browser_delayed(self, port: int) -> None Open browser after a short delay (in background thread). Uses a background thread to avoid blocking server startup. Parameters 1 port int Port number to include in the URL ← Previous constants Next → live_reload 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: 1744 - Reading Time: 9 minutes