Agent skill · writing content · aj-geddes

documentation-site-setup

Set up documentation websites using Docusaurus, MkDocs, VitePress, GitBook, or static site generators. Use when creating docs sites, setting up documentation portals, or building static documentation.

Why this skill is useful

Provides specific commands and best practices for setting up documentation sites with various static site generators that the AI may not reliably generate on its own.

What it needs

Requires npm installed locally. About 1k tokens when loaded. Last updated 2026-03-04. 307 stars on the source repository.

What this skill does

Documentation Site Setup Table of Contents Overview When to Use Quick Start Reference Guides Best Practices Overview Set up professional documentation websites using popular static site generators like Docusaurus, MkDocs, VitePress, and GitBook. When to Use Documentation website setup API documentation portals Product documentation sites Technical documentation hubs Static site generation GitHub Pages deployment Multi-version documentation Quick Start Multi-version documentation Reference Guides Detailed implementations in the references/ directory: Guide Contents --- --- Installation Installation, Project Structure Configuration Configuration Sidebar Configuration Sidebar Configuration Versioning Versioning, Deployment Installation Installation, Project Structure Configuration Configuration Admonitions Admonitions, Deployment Installation Installation Configuration Configuration Installation Installation, Project Structure, Configuration, Table of Contents Best Practices ✅ DO Use consistent navigation structure Enable search functionality Add edit links to pages Include version selector for versioned docs Use syntax highlighting for code blocks Add dark mode support Optimize images and assets Enable analytics Add social media links Use responsive design Include breadcrumbs Add table of contents Test on mobile devices ❌ DON'T Use outdated frameworks Skip search functionality Forget mobile responsiveness Use slow-loading assets Skip accessibility features Ignore SEO optimization

How to use it

Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:

@skills aj-geddes/documentation-site-setup

View the source on GitHub

Browse the @skills marketplace