build-docs

Validate markdown documentation with strict mkdocs build checks.

21|6|Updated Dec 15, 2022
One-click install
npx skills add https://github.com/CERTCC/Vultron --skill build-docs-certcc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: build-docs
Source: https://github.com/CERTCC/Vultron/tree/main/.agents/skills/build-docs
Command: npx skills add https://github.com/CERTCC/Vultron --skill build-docs-certcc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint-cli2, mkdocs, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps maintain high-quality documentation by verifying that all documentation builds correctly without warnings or broken links, reducing errors in published content.

Core Features & Use Cases

  • Documentation Validation: Runs mkdocs build --strict to detect broken links, missing files, or markdown syntax errors.
  • CI/CD Integration: Ensures documentation is error-free before deployment or staging, supporting continuous deployment processes.
  • Use Case: When updating the docs/ directory, initiate this Skill to validate complete, error-free documentation before commit or deployment.

Quick Start

Run the build script to verify your documentation in strict mode and fix any reported issues.

Frequently Asked Questions about build-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check markdown documentation for broken links before deployment?

To validate markdown documentation for broken links, run a strict build process using mkdocs that detects missing files and syntax errors before deployment. This Skill executes mkdocs build --strict to automatically verify all links resolve correctly and markdown syntax passes validation.

How does mkdocs strict build validation work for detecting documentation errors?

Strict build validation works by executing mkdocs build --strict, which treats warnings as errors during documentation compilation. It detects broken internal links, missing files, and markdown syntax errors, causing the build process to fail immediately if any validation issues are found.

Do I need markdownlint-cli2 and mkdocs to validate documentation builds?

Yes, markdownlint-cli2 and mkdocs are required dependencies to perform documentation build validation. Markdownlint-cli2 enforces markdown syntax rules while mkdocs builds the documentation site in strict mode to detect broken links, missing files, and syntax errors during the validation process.

Can I integrate markdown documentation validation into a CI/CD pipeline?

Yes, you can integrate markdown documentation validation into CI/CD pipelines to ensure content is error-free before staging or deployment. Running strict build checks in your pipeline prevents broken links and markdown syntax errors from reaching production, supporting continuous deployment processes.

What is the best way to prevent broken links in project documentation?

The best way to prevent broken links in project documentation is to enforce strict build validation checks before commits or deployment. Initiating this validation on the docs directory ensures all internal links resolve correctly and markdown syntax remains consistent across content updates.

Why does my mkdocs build fail when updating documentation?

Your mkdocs build fails when updating documentation because strict mode treats warnings as errors, catching broken links or missing files introduced during the update. Fix the reported markdown syntax errors and verify all internal links point to existing files to resolve the build failure.