documentation-mkdocs-setup
Sub-skill of documentation: MkDocs Setup (+3).
Best use case
documentation-mkdocs-setup is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Sub-skill of documentation: MkDocs Setup (+3).
Teams using documentation-mkdocs-setup should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/mkdocs-setup/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How documentation-mkdocs-setup Compares
| Feature / Agent | documentation-mkdocs-setup | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Sub-skill of documentation: MkDocs Setup (+3).
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# MkDocs Setup (+3)
## MkDocs Setup
```bash
# See mkdocs for complete patterns
pip install mkdocs mkdocs-material
# Initialize project
mkdocs new my-docs
cd my-docs
# mkdocs.yml configuration
cat > mkdocs.yml << 'EOF'
site_name: My Documentation
theme:
name: material
palette:
primary: indigo
features:
- navigation.tabs
- search.highlight
plugins:
- search
- minify
nav:
- Home: index.md
- Getting Started: getting-started.md
- API Reference: api.md
EOF
# Serve locally
mkdocs serve
# Build for production
mkdocs build
```
## Sphinx Autodoc
```bash
# See sphinx for complete patterns
pip install sphinx sphinx-rtd-theme
# Initialize
sphinx-quickstart docs
# conf.py configuration
cat >> docs/conf.py << 'EOF'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
]
autodoc_default_options = {
'members': True,
'undoc-members': True,
'show-inheritance': True,
}
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
}
EOF
# Generate API docs
sphinx-apidoc -o docs/api src/
# Build HTML
sphinx-build -b html docs docs/_build
```
## Pandoc Conversion
```bash
# See pandoc for complete patterns
# Markdown to PDF
pandoc README.md -o output.pdf \
--pdf-engine=xelatex \
--template=template.tex \
--toc
# Markdown to Word
pandoc doc.md -o output.docx \
--reference-doc=template.docx
# Multiple files to single document
pandoc chapter1.md chapter2.md chapter3.md \
-o book.pdf \
--toc \
--number-sections
# HTML to Markdown
pandoc https://example.com/page.html -o page.md
```
## Marp Presentation
```bash
# See marp for complete patterns
npm install -g @marp-team/marp-cli
# Create presentation
cat > slides.md << 'EOF'
---
marp: true
theme: default
paginate: true
---
# Presentation Title
Speaker Name
2026-01-17
---Related Skills
tax-filing-session-setup-with-github-tracking
Structured workflow for preparing and tracking a tax filing session using prepared documents, task checklist, and GitHub issue cross-referencing
tax-filing-session-setup-with-github-traceability
Structured workflow for setting up a multi-file tax filing session with GitHub issue tracking and prepared-file validation
documentation-contract-plan-hardening
Harden a documentation/contract plan before adversarial review by mapping every issue-scope requirement to independent acceptance criteria and tests, especially for routing/indexing contracts.
orcaflex-vessel-setup
Configure 6-DOF vessels in OrcaFlex with hydrodynamic properties, RAO import from AQWA, and vessel type creation. Covers initial position, orientation, calculation settings, and motion options.
hermes-windows-setup
Install and configure a repo-centric Hermes agent workspace on Windows. Covers prerequisites, repo cloning, Python/uv environment, skills system, memory bridge, and multi-agent coordination — the Windows equivalent of the Linux workspace-hub pattern.
gh-issue-creation-full-repo-and-batch-setup
Create multiple related GitHub issues safely by resolving full OWNER/REPO, checking duplicates and labels first, and verifying each created issue.
semantic-search-setup
Setup vector embeddings and semantic search for document collections. Use for AI-powered similarity search, finding related documents, and preparing knowledge bases for RAG systems.
modular-architecture-documentation
Systematically document multi-module system architectures including module boundaries, CLI commands, and architecture decisions.
mkdocs-with-title
Sub-skill of mkdocs: With Title.
mkdocs-warning
MkDocs warning admonition syntax. Use when alerting readers to potential issues or cautions in MkDocs documentation.
mkdocs-tip
MkDocs tip admonition syntax. Use when adding best-practice suggestions or pro tips to MkDocs documentation.
mkdocs-tabbed-code-blocks
Sub-skill of mkdocs: Tabbed Code Blocks.