validate-docs-rendered

What problem does it solve?

Verify that project documentation renders correctly in common viewers (GitHub, GitLab, and Markdown renderers) by validating diagrams, internal links, YAML frontmatter consistency, and code blocks with declared languages. It helps catch rendering defects that surface after reviews, preventing broken docs from leaking into production.

Core Features & Use Cases

• Mermaid diagrams: validates basic syntax and ensures participants are declared before use within Mermaid blocks.
• Link integrity: checks internal links and anchors for existence and correct anchors, including relative paths and repository roots.
• Frontmatter consistency: ensures YAML frontmatter is well-formed and contains required fields for rendering.
• Code block hygiene: flags fences without explicit languages to improve readability in viewers.
• Use Case: run this on a docs/ directory to identify issues that would cause broken rendering in downstream consumers.

Quick Start

Run the validation on the target docs directory to verify rendering across viewers.