documentation-site-setup
>
Works with
--- name: documentation-site-setup description: > license: MIT --- # Documentation Site Setup ## Table of Contents - [Overview](#overview) - [When to Use](#when-to-use) - [Quick Start](#quick-start) - [Reference Guides](#reference-guides) - [Best Practices](#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 ```bash # 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](references/installation.md) | Installation, Project Structure | | [Configuration](references/configuration.md) | Configuration | | [Sidebar Configuration](references/sidebar-configuration.md) | Sidebar Configuration | | [Versioning](references/versioning.md) | Versioning, Deployment | | [Installation](references/installation-2.md) | Installation, Project Structure | | [Configuration](references/configuration-2.md) | Configuration | | [Admonitions](references/admonitions.md) | Admonitions, Deployment | | [Installation](references/installation-3.md) | Installation | | [Configuration](references/configuration-3.md) | Configuration | | [Installation](references/installation-4.md) | 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
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
