mkdocs-lint

Lint MkDocs rendering issues and fix broken code fences automatically.

1|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/arakitakashi/homework-coach-robo --skill mkdocs-lint
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mkdocs-lint
Source: https://github.com/arakitakashi/homework-coach-robo/tree/main/ref/adk-streaming-guide-main/.claude/skills/mkdocs-lint
Command: npx skills add https://github.com/arakitakashi/homework-coach-robo --skill mkdocs-lint

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses common and critical rendering issues in MkDocs documentation, ensuring a clean and consistent output without manual debugging.

Core Features & Use Cases

  • Automated Linting: Identifies broken code fences, unclosed admonitions, and missing language tags.
  • Automatic Fixing: Corrects indentation issues, adds missing blank lines, and formats code blocks.
  • Use Case: Integrate this Skill into your pre-commit hooks to automatically catch and fix documentation rendering bugs before they are committed, maintaining a high standard of documentation quality.

Quick Start

Run the mkdocs-lint skill to clean rebuild the MkDocs site and check for rendering issues.

Frequently Asked Questions about mkdocs-lint

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

FAQPage Schema
How do I fix broken code fences and unclosed admonitions in MkDocs?

To fix MkDocs rendering issues like broken code fences and unclosed admonitions, you can use an automated linting tool that identifies and automatically corrects these formatting and syntax errors.

Why does my MkDocs documentation output have inconsistent HTML rendering?

Inconsistent HTML rendering in MkDocs is often caused by formatting problems such as missing code block language tags, broken fences, or unclosed admonitions that require linting and automated fixing.

How do I automatically add missing language tags to code blocks in MkDocs?

You can automatically add missing language tags and fix indentation by running an automated MkDocs linting process that detects syntax errors and applies formatting fixes for consistent output.

Can I integrate MkDocs linting into pre-commit hooks?

Yes, you can integrate MkDocs linting into your pre-commit hooks to automatically catch and fix documentation rendering bugs, ensuring a high standard of quality before changes are committed.

What is the best way to clean rebuild a MkDocs site and check for rendering issues?

The best way to clean rebuild a MkDocs site and check for rendering issues is to run an automated linting process that identifies critical problems and applies fixes to ensure consistent HTML output.