validate-docs-rendered

Markdown documentation rendering validation checks Mermaid diagrams, internal links, YAML frontmatter, and code blocks to prevent broken docs in viewers like GitHub and GitLab. It catches rendering defects early before they leak into production.

You can check internal links and anchors in a docs directory before commit. Validation verifies relative paths, repository roots, and anchor targets for existence, preventing broken navigation in rendered documentation downstream.

Mermaid diagrams fail to render in GitHub when participants are used before declaration or syntax is malformed. Validation checks Mermaid blocks for basic syntax and ensures participants are declared before use to catch these issues.

Documentation validation works with CI workflows by enforcing structured output and exiting with a non-zero code when critical issues are found. It supports parallel checks to integrate seamlessly into pre-commit hooks.

The best way to enforce YAML frontmatter consistency is by validating that frontmatter is well-formed and contains required rendering fields. This ensures metadata across markdown files remains uniform for downstream documentation consumers.

Flag code blocks without declared languages by scanning markdown files for fences missing explicit language identifiers. This code block hygiene check improves readability in viewers by ensuring proper syntax highlighting.