Documentation Site Setup

What it does

This skill enables AI agents to set up professional documentation websites using popular static site generators, including Docusaurus, MkDocs, VitePress, and GitBook. It provides guidance on installation, configuration, sidebar setup, versioning, and deployment for these platforms. The goal is to streamline the creation of API documentation portals, product documentation sites, technical documentation hubs, and other similar resources.

When to use it

• Creating a new documentation website from scratch using Docusaurus or another supported static site generator.
• Setting up multi-version documentation for software products or APIs.
• Configuring the structure and layout of a documentation site (e.g., sidebar, table of contents).
• Deploying a documentation site to GitHub Pages or other hosting platforms.
• Implementing version selection functionality on your documentation portal.

Key capabilities

• Supports Docusaurus, MkDocs, VitePress, and GitBook static site generators.
• Provides guidance on installation and project structure.
• Offers configuration instructions for various aspects of the documentation site.
• Covers sidebar configuration and versioning/deployment processes.
• Includes best practices for creating effective documentation sites (e.g., consistent navigation, search functionality, responsive design).

Example prompts

• "Create a new Docusaurus site named 'my-docs' using the classic template."
• "How do I configure versioning in my MkDocs documentation site?"
• “What are some best practices for mobile responsiveness on a VitePress website?”

Tips & gotchas

• The skill focuses on setup and configuration; it doesn’t cover content creation itself.
• Familiarity with command-line tools (like npm or similar package managers) is helpful.
• Refer to the reference guides within the skill for detailed implementation steps for specific configurations.