Agent-Skills.md

Agent Skills: 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.

UncategorizedID: aj-geddes/useful-ai-prompts/documentation-site-setup

Repository

aj-geddes/useful-ai-prompts
aj-geddesLicense: MIT
607

Install this agent skill to your local

pnpm dlx add-skill https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/documentation-site-setup

Skill Files

Browse the full folder contents for documentation-site-setup.

Download Skill

Loading file tree…

skills/documentation-site-setup/SKILL.md

Skill Metadata

Name
documentation-site-setup
Description
>

Documentation Site Setup

Table of Contents

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
# Create new Docusaurus site
npx create-docusaurus@latest my-docs classic

cd my-docs

# Install dependencies
npm install

# Start development server
npm start

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