mcpField
D
documentation-site-setup

documentation-site-setup

github.com/aj-geddesDevelopment373449 installsUpdated 34w ago
Repository

About documentation-site-setup

A skill for setting up static documentation websites with generators such as Docusaurus, MkDocs, VitePress, and GitBook. It includes setup guidance for documentation sites and related configuration, versioning, and deployment topics.

Key features

  1. 01Docusaurus、MkDocs、VitePress 和 GitBook
  2. 02安装与项目结构指南
  3. 03侧边栏和站点配置
  4. 04文档版本管理与部署

Use cases

  1. 01搭建产品文档网站
  2. 02创建 API 文档门户
  3. 03发布多版本技术文档
  4. 04部署静态文档站点

Install

Copy the command and run it in a terminal.

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

After installing, type/documentation-site-setupin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
admonitions.md
configuration-2.md
configuration-3.md
configuration.md
installation-2.md
installation-3.md
installation-4.md
installation.md
sidebar-configuration.md
versioning.md
templates/
component-template.tsx

Details

From the project README

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:

GuideContents
InstallationInstallation, Project Structure
ConfigurationConfiguration
Sidebar ConfigurationSidebar Configuration
VersioningVersioning, Deployment
InstallationInstallation, Project Structure
ConfigurationConfiguration
AdmonitionsAdmonitions, Deployment
InstallationInstallation
ConfigurationConfiguration
InstallationInstallation, 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

Comments

Markdown supported