Documents

documentation-site-setup

aj-geddes/useful-ai-prompts · updated Apr 8, 2026

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill documentation-site-setup
summary

Set up professional documentation websites using popular static site generators like Docusaurus, MkDocs, VitePress, and GitBook.

skill.md

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
general reviews

Ratings

4.510 reviews
  • Shikha Mishra· Oct 10, 2024

    documentation-site-setup is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • Piyush G· Sep 9, 2024

    Keeps context tight: documentation-site-setup is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Chaitanya Patil· Aug 8, 2024

    Registry listing for documentation-site-setup matched our evaluation — installs cleanly and behaves as described in the markdown.

  • Sakshi Patil· Jul 7, 2024

    documentation-site-setup reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Ganesh Mohane· Jun 6, 2024

    I recommend documentation-site-setup for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Oshnikdeep· May 5, 2024

    Useful defaults in documentation-site-setup — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • Dhruvi Jain· Apr 4, 2024

    documentation-site-setup has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Rahul Santra· Mar 3, 2024

    Solid pick for teams standardizing on skills: documentation-site-setup is focused, and the summary matches what you get after install.

  • Pratham Ware· Feb 2, 2024

    We added documentation-site-setup from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Yash Thakker· Jan 1, 2024

    documentation-site-setup fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.