mcpField
D
documentation-site-setup

documentation-site-setup

github.com/aj-geddes开发373449 次安装34 周前更新
代码仓库

关于 documentation-site-setup

用于使用 Docusaurus、MkDocs、VitePress 和 GitBook 等生成器搭建静态文档网站的技能，涵盖站点设置以及配置、版本管理和部署相关主题。

主要功能

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

适用场景

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

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/documentation-site-setup确认已加载。

包含的文件

除 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

详细介绍

文档网站设置

目录

概览

使用 Docusaurus、MkDocs、VitePress 和 GitBook 等热门静态网站生成器，搭建专业的文档网站。

适用场景

  • 文档网站搭建
  • API 文档门户
  • 产品文档网站
  • 技术文档中心
  • 静态网站生成
  • GitHub Pages 部署
  • 多版本文档

快速入门

  • 多版本文档
# Create new Docusaurus site
npx create-docusaurus@latest my-docs classic

cd my-docs

# Install dependencies
npm install

# Start development server
npm start

参考指南

references/ 目录中的详细实现：

指南内容
安装安装、项目结构
配置配置
侧边栏配置侧边栏配置
版本管理版本管理、部署
安装安装、项目结构
配置配置
提示框提示框、部署
安装安装
配置配置
安装安装、项目结构、配置、目录

最佳实践

✅ 应该做
  • 使用一致的导航结构
  • 启用搜索功能
  • 为页面添加编辑链接
  • 为包含多个版本的文档添加版本选择器
  • 为代码块启用语法高亮
  • 添加深色模式支持
  • 优化图片和资源
  • 启用分析功能
  • 添加社交媒体链接
  • 使用响应式设计
  • 添加面包屑导航
  • 添加目录
  • 在移动设备上进行测试
❌ 不应该做
  • 使用过时的框架
  • 不启用搜索功能
  • 忽略移动设备适配
  • 使用加载缓慢的资源
  • 忽略无障碍功能
  • 忽略 SEO 优化

评论

支持 Markdown