# anchors URL: /api/health/validators/anchors/ Section: validators -------------------------------------------------------------------------------- anchors - 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 Health Validators ᗢ 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 health.validators.anchors Anchor validator for validating explicit anchors and cross-references. Part of the explicit anchor system (RFC: plan/active/rfc-explicit-anchor-targets.md). Validates: Duplicate anchor IDs within pages Broken [[#anchor]] cross-references Key Features: Detect duplicate anchor IDs in rendered HTML Validate [[#anchor]] references against xref_index Support for both heading anchors and {target} directive anchors Related Modules: bengal.health.base: BaseValidator interface bengal.health.report: CheckResult for reporting bengal.rendering.plugins.directives.target: Target directive bengal.rendering.parsers.mistune: Heading {#id} syntax See Also: bengal/health/validators/cross_ref.py: General cross-reference validation bengal/rendering/plugins/cross_references.py: [[link]] resolution View source 1 Class 1 Function Classes AnchorValidator Validates explicit anchors and [[#anchor]] cross-references. Performs two main validations: 1. Dup… 6 Caret Right Validates explicit anchors and [[#anchor]] cross-references. Performs two main validations: Duplicate anchors: Scans rendered HTML for duplicate id="..." attributes Broken references: Validates [[#anchor]] syntax against known anchors Creation: health_check.register(AnchorValidator()) Configuration: In bengal.yaml: health_check: validators: anchors: true # Enable/disable anchor validation Inherits from BaseValidator Attributes Name Type Description strict — If True, treat warnings as errors (for CI builds) Methods 1 validate Validate anchors across all site pages. 2 list[CheckResult] Caret Right def validate(self, site: Site, build_context: Any | None = None) -> list[CheckResult] Validate anchors across all site pages. Parameters 2 site Site Site to validate build_context Any | None Optional BuildContext (not used by this validator) Returns list[CheckResult] — List of CheckResults for anchor issues Internal Methods 5 Caret Right __init__ Initialize anchor validator. 1 None Caret Right def __init__(self, strict: bool = False) Initialize anchor validator. Parameters 1 strict bool If True, report duplicate anchors as errors instead of warnings _build_valid_anchor_set Build set of all valid anchor IDs from xref_index. Combines both explicit anch… 1 set[str] Caret Right def _build_valid_anchor_set(self, site: Site) -> set[str] Build set of all valid anchor IDs from xref_index. Combines both explicit anchors (from {#id} and {target}) and heading anchors for comprehensive validation. Parameters 1 site Site Site with built xref_index Returns set[str] — Set of lowercase anchor IDs _validate_duplicate_anchors Check for duplicate anchor IDs within a single page. Scans rendered HTML for a… 1 list[CheckResult] Caret Right def _validate_duplicate_anchors(self, page: Any) -> list[CheckResult] Check for duplicate anchor IDs within a single page. Scans rendered HTML for all id="..." attributes and reports any duplicates. Duplicate anchors cause navigation issues and invalid HTML. Parameters 1 page Any Page to validate Returns list[CheckResult] — List of CheckResults for duplicate anchors _validate_anchor_references Check that all [[#anchor]] references resolve to existing anchors. Validates c… 2 list[CheckResult] Caret Right def _validate_anchor_references(self, page: Any, valid_anchors: set[str]) -> list[CheckResult] Check that all [[#anchor]] references resolve to existing anchors. Validates cross-reference syntax against the set of known anchors from the xref_index. Parameters 2 page Any Page to validate valid_anchors set[str] Set of valid anchor IDs (lowercase) Returns list[CheckResult] — List of CheckResults for broken references _find_similar_anchors Find anchors similar to the broken reference (for suggestions). Uses simple su… 2 list[str] Caret Right def _find_similar_anchors(self, anchor: str, valid_anchors: set[str]) -> list[str] Find anchors similar to the broken reference (for suggestions). Uses simple substring matching to suggest possible fixes. Parameters 2 anchor str The broken anchor reference valid_anchors set[str] Set of valid anchors Returns list[str] — List of up to 3 similar anchor names Functions create_anchor_validator Factory function to create an AnchorValidator. 1 AnchorValidator Caret Right def create_anchor_validator(strict: bool = False) -> AnchorValidator Factory function to create an AnchorValidator. Parameters 1 Name Type Default Description strict bool False If True, report duplicate anchors as errors Returns AnchorValidator — Configured AnchorValidator Next → assets 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: 1478 - Reading Time: 7 minutes