# schemas URL: /api/collections/schemas/ Section: collections -------------------------------------------------------------------------------- schemas - 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 Collections ᗢ 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 collections.schemas Standard collection schemas for common content types. Provides ready-to-use schemas for blog posts, documentation pages, and API references. Users can import and use these directly or as a starting point for custom schemas. Usage: from bengal.collections import define_collection from bengal.collections.schemas import BlogPost, DocPage collections = { "blog": define_collection(schema=BlogPost, directory="content/blog"), "docs": define_collection(schema=DocPage, directory="content/docs"), } Or extend standard schemas: from dataclasses import dataclass, field from bengal.collections.schemas import BlogPost @dataclass class MyBlogPost(BlogPost): '''Extended blog post with custom fields.''' series: str | None = None reading_time: int | None = None View source 5 Classes Classes BlogPost dataclass Standard schema for blog posts. Required: title: Post title (displayed in listings and page he… 0 Caret Right Standard schema for blog posts. Required: title: Post title (displayed in listings and page header) date: Publication date (used for sorting and display) Optional: author: Post author (defaults to "Anonymous") tags: List of tags for categorization draft: If True, page excluded from production builds description: Short description for meta tags and listings image: Featured image path (relative to assets or absolute URL) excerpt: Manual excerpt (auto-generated from content if not set) Example frontmatter: --- title: Getting Started with Bengal date: 2025-01-15 author: Jane Doe tags: [tutorial, beginner] description: Learn how to build your first Bengal site --- Attributes Name Type Description title str date datetime author str tags list[str] draft bool description str | None image str | None excerpt str | None DocPage dataclass Standard schema for documentation pages. Required: title: Page title Optional: weight: So… 0 Caret Right Standard schema for documentation pages. Required: title: Page title Optional: weight: Sort order within section (lower = earlier, default 0) category: Category for grouping in navigation tags: List of tags for cross-referencing toc: Whether to show table of contents (default True) description: Page description for meta tags deprecated: Mark page as deprecated (shows warning banner) since: Version when feature was introduced (e.g., "1.2.0") Example frontmatter: --- title: Configuration Reference weight: 10 category: Reference toc: true --- Attributes Name Type Description title str weight int category str | None tags list[str] toc bool description str | None deprecated bool since str | None APIReference dataclass Standard schema for API reference documentation. Required: title: API endpoint or method name … 0 Caret Right Standard schema for API reference documentation. Required: title: API endpoint or method name endpoint: API endpoint path (e.g., "/api/v1/users") Optional: method: HTTP method (default "GET") version: API version (default "v1") deprecated: Mark endpoint as deprecated auth_required: Whether authentication is required (default True) rate_limit: Rate limit description (e.g., "100 req/min") description: Endpoint description Example frontmatter: --- title: List Users endpoint: /api/v1/users method: GET version: v1 auth_required: true rate_limit: 100 req/min --- Attributes Name Type Description title str endpoint str method str version str deprecated bool auth_required bool rate_limit str | None description str | None Changelog dataclass Standard schema for changelog entries. Required: title: Release title (e.g., "v1.2.0" or "Vers… 0 Caret Right Standard schema for changelog entries. Required: title: Release title (e.g., "v1.2.0" or "Version 1.2.0") date: Release date Optional: version: Semantic version string breaking: Whether this release has breaking changes draft: If True, not published yet summary: Short release summary Example frontmatter: --- title: Version 1.2.0 date: 2025-01-15 version: 1.2.0 breaking: false summary: New features and bug fixes --- Attributes Name Type Description title str date datetime version str | None breaking bool draft bool summary str | None Tutorial dataclass Standard schema for tutorial/guide pages. Required: title: Tutorial title Optional: diffi… 0 Caret Right Standard schema for tutorial/guide pages. Required: title: Tutorial title Optional: difficulty: Skill level (beginner, intermediate, advanced) duration: Estimated completion time (e.g., "30 minutes") prerequisites: List of prerequisite knowledge/tutorials tags: List of tags series: Name of tutorial series this belongs to order: Order within series (1, 2, 3, ...) Example frontmatter: --- title: Building Your First Site difficulty: beginner duration: 30 minutes prerequisites: Python basics Command line familiarity series: Getting Started order: 1 Attributes Name Type Description title str difficulty str | None duration str | None prerequisites list[str] tags list[str] series str | None order int | None ← Previous loader Next → validator 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: 1597 - Reading Time: 8 minutes