Documentation Site Setup

aj-geddes/useful-ai-prompts/skills/documentation-site-setup

by aj-geddes3f5182cfd739No license355 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 7 months ago

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.

Instructions onlySoftware Development

AI-generated overview

Sets up documentation websites with Docusaurus, MkDocs, VitePress, GitBook or other static site generators.

What it does: This skill guides the setup of documentation websites and portals using static site generators such as Docusaurus, MkDocs, VitePress and GitBook. It provides a quick-start command sequence for creating a Docusaurus site, plus reference guides covering installation, project structure, configuration, sidebar setup, versioning, deployment and admonitions. It also lists best practices for navigation, search, version selectors, accessibility, SEO and mobile responsiveness. It ships no scripts; the work is instructional guidance and reference material.
When to use it: Use it when creating a documentation site, setting up a documentation portal or technical documentation hub, building API documentation, or generating static documentation with GitHub Pages deployment or multi-version support.
Requirements: No scripts are included; it is instructions and reference documents only. Following the quick start requires Node.js and npm (npx create-docusaurus) and network access to fetch packages, and the referenced generators may need their own runtimes.

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

bash

# Create new Docusaurus sitenpx create-docusaurus@latest my-docs classic
cd my-docs
# Install dependenciesnpm install
# Start development servernpm start

# Create new Docusaurus sitenpx create-docusaurus@latest my-docs classic
cd my-docs
# Install dependenciesnpm install
# Start development servernpm start

Reference Guides

Detailed implementations in the references/ directory:

Guide	Contents
Installation [blocked]	Installation, Project Structure
Configuration [blocked]	Configuration
Sidebar Configuration [blocked]	Sidebar Configuration
Versioning [blocked]	Versioning, Deployment
Installation [blocked]	Installation, Project Structure
Configuration [blocked]	Configuration
Admonitions [blocked]	Admonitions, Deployment
Installation [blocked]	Installation
Configuration [blocked]	Configuration
Installation [blocked]	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

Source and attribution

Source:aj-geddes/useful-ai-promptsinskills/documentation-site-setupat commit3f5182c

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

Documentation Site Setup

Documentation Site Setup

Table of Contents

Overview

When to Use

Quick Start

Reference Guides

Best Practices

✅ DO

❌ DON'T

Source and attribution

More from aj-geddes/useful-ai-prompts

Xss Prevention

Wireframe Prototyping

Web Performance Optimization

Vue Application Structure

Visual Regression Testing

User Persona Creation

More in Software Development

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices