
地 址:联系地址联系地址联系地址
电 话:020-123456789
网址:whcdba.com
邮 箱:admin@aa.com
一、搭建使用Docusaurus(推荐)
Docusaurus是个网Facebook开源的静态网站生成器,专为文档网站设计,站的自己支持Markdown编辑、流程版本控制、网站文档搜索功能等,建设适合技术文档、搭建项目说明等场景。个网

步骤:


确保安装了Node.js(版本≥16.14),站的自己然后全局安装Docusaurus CLI:
```bash
npm install -g create-docusaurus@latest
```
创建项目
运行以下命令创建新项目(默认使用`classic`主题):
```bash
create-docusaurus@latest my-website
```
进入项目目录:
```bash
cd my-website
```
配置项目
编辑`docusaurus.config.js`进行自定义(如主题、流程路由等);
在`docs`目录下添加Markdown文件,网站文档如`README.md`作为首页。建设
启动开发服务器
运行:
```bash
npm start
```
访问`http://localhost:3000`预览效果。搭建
部署到GitHub Pages
在GitHub上创建仓库,个网将项目推送到该仓库;
在仓库设置中启用GitHub Pages,站的自己选择`master`分支作为发布源。
二、使用Docsify
Docsify是一个轻量级工具,支持实时预览Markdown文件,无需生成静态HTML,适合个人博客或小型文档集。
步骤:
安装工具
全局安装Docsify CLI:
```bash
npm install -g docsify-cli
```
初始化项目
创建项目目录并初始化:
```bash
mkdir my-docs
cd my-docs
docsify init ./docs
```
生成`index.html`等基础文件。
配置Docsify
编辑`docs/.nojekyll`(禁用Jekyll)和`docs/index.html`中的配置,如侧边栏、主题等。
启动本地服务器
运行:
```bash
docsify serve ./docs
```
访问`http://localhost:3000`预览。
部署(可选)
可将项目导入静态网站托管服务(如Vercel、Netlify);
GitHub Pages也支持,需配置`_config.yml`文件。
选择建议:
Docusaurus: 适合需要复杂功能(如搜索、多文档管理)的团队或个人项目,社区支持更完善。 Docsify
两种工具均支持实时预览,便于快速迭代。根据需求选择后,可通过GitHub等平台轻松部署。