
地 址:联系地址联系地址联系地址
电 话:020-123456789
网址:whcdba.com
邮 箱:admin@aa.com
一、何搭Docusaurus 搭建指南
1. 安装与初始化

环境要求:需安装 Node.js(版本≥14/16)

创建项目:运行命令 `npx create-docusaurus@latest my-website classic`(使用经典主题模板)

启动开发服务器:进入项目目录后执行 `npm start`,建局访问 `http://localhost:3000` 即可看到默认站点
2. 配置与自定义
基础配置:编辑 `docusaurus.config.js`,域网设置 `site_name`、搭建`site_url`、个人导航菜单等
高级功能:
React 组件:通过 `src` 目录添加自定义 React 组件
国际化:内置多语言支持
部署:支持 GitHub Pages、文档网站Netlify 等平台一键部署
3. 文档结构与主题
文档存放:在 `docs` 目录编写 Markdown 文件,何搭支持目录导航
主题扩展:提供多种主题(如 `classic`、建局`readthedocs`),域网可通过 `theme` 配置项切换
实时预览:修改文档后无需重新构建,搭建直接刷新浏览器即可更新
二、个人MkDocs 搭建指南
1. 安装与初始化
安装工具:通过 `pip install mkdocs` 安装
创建项目:运行 `mkdocs new my_docs`,文档网站生成 `docs` 目录及基础配置文件
启动开发服务器:执行 `mkdocs serve`,何搭访问 `http://localhost:8000` 预览站点
2. 配置与扩展
基础配置:编辑 `mkdocs.yml`,建局设置 `site_name`、域网`site_url`、导航菜单等
主题与插件:
主题切换:支持 `readthedocs`、`alabaster` 等主题,可通过 `theme` 配置项更换
插件扩展:集成代码高亮(`docsify-copy-code`)、图片缩放(`zoom-image`)等实用插件
动态渲染:Markdown 文件修改后无需重新构建,实现实时更新
3. 部署与集成
静态站点托管:支持 GitHub Pages、Netlify 等平台部署
与 GitBook 集成:可通过 API 或插件实现与 GitBook 的双向同步
三、选择建议
Docusaurus:适合需要 React 组件、国际化或复杂交互的文档网站,社区活跃且功能丰富
MkDocs:轻量级且插件生态丰富,适合快速搭建纯文档站点,尤其适合技术文档和代码库
根据项目需求选择工具,若需进一步定制,可参考官方文档或社区示例。