manual

Build MkDocs manuals as HTML and optionally export to DOCX.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/escotilha/claude-public --skill manual-escotilha
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: manual
Source: https://github.com/escotilha/claude-public/tree/main/skills/manual
Command: npx skills add https://github.com/escotilha/claude-public --skill manual-escotilha

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It removes the friction of maintaining up-to-date user documentation by automatically building a MkDocs manual (and optionally exporting it to Word), including support for embedding UI screenshots.

Core Features & Use Cases

  • MkDocs HTML build from your existing config: Detects mkdocs-manual.yml, mkdocs.yml (with docs_dir: manual), or a manual/ folder and renders strict HTML output for a ready-to-serve documentation site.
  • Optional Word export for offline sharing: Converts the manual into a .docx via Pandoc using navigation order derived from your MkDocs config metadata.
  • Automatic screenshot capture and embedding: Captures browser screenshots from a running app (using screenshots.yml / manual-screenshots.yml configs or inline <!-- screenshot: ... --> directives) and updates the markdown docs to include the images.

Quick Start

Run: /manual word to build your manual site and export it as a Word document.

Frequently Asked Questions about manual

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

FAQPage Schema
How do I build MkDocs documentation and export it to a Word document?▼

To build MkDocs documentation and export it to Word, the Skill executes mkdocs build for HTML output and uses Pandoc to convert the markdown into a .docx file. It automatically derives the navigation order from your existing MkDocs configuration metadata.

Can I automate capturing UI screenshots and embedding them in my technical documentation?▼

Yes, you can automate capturing UI screenshots for technical documentation using Chrome DevTools. The Skill captures browser screenshots from a running application based on inline directives or configuration files, then updates the markdown to embed the images.

Does the markdown to DOCX conversion process require Pandoc?▼

Yes, the markdown to DOCX conversion requires Pandoc to generate the Word document. The Skill relies on Pandoc to translate the built MkDocs markdown content into a properly formatted .docx file using site metadata for structure.

What configuration files are needed to generate a project manual from a manual directory?▼

To generate a project manual, the Skill detects a `mkdocs-manual.yml`, a `mkdocs.yml` with `docs_dir: manual`, or a standard `manual/` folder. It uses these configuration files to locate the content and render the strict HTML documentation site.

What is the best way to maintain up-to-date user manuals alongside code changes?▼

The best way to maintain up-to-date user manuals is to automate the rendering and export process. This Skill removes documentation friction by building MkDocs HTML and optionally exporting a Word document directly from your repository configuration.

Are there limitations when using a Makefile target to render MkDocs HTML output?▼

When using a Makefile target to render MkDocs HTML output, the Skill will execute the `manual` target if present instead of the standard mkdocs build command. This ensures compatibility with custom build workflows but requires the Makefile target to be correctly configured.