nx-docs-style-check

To validate Nx docs against the astro style guide, run an automated style check on modified MD and MDX files. This process verifies frontmatter, headings, code blocks, links, callouts, terminology, and tone to ensure consistency before commits or reviews.

Markdown linting in Nx documentation checks frontmatter field validity, heading structure, code block language tags, and internal relative links. It also enforces callout syntax, Nx terminology alignment, and tone according to the astro-docs STYLE_GUIDE.md.

Checking MDX frontmatter formatting for Nx docs involves validating required fields and ensuring proper title formatting. The style check automatically identifies missing or incorrectly formatted frontmatter in modified MD and MDX files within the nx repo.

Yes, the Nx docs style check works with both MD and MDX files in the nx repo. It validates modified astro-docs content pages against the style guide, checking structural elements like code blocks and internal links during doc edits or review prompts.

You should run a docs style check during Nx development after editing any documentation page and before creating pull requests. Running it pre-review detects structural, terminology, and formatting issues early, ensuring documentation meets style guide consistency requirements.