docsify 配置工作流
时间: 2024-06-19 12:03:37 浏览: 10
docsify 是一款基于 JavaScript 的文档生成工具,可以用来快速构建文档网站。下面是一般的 docsify 配置工作流:
1. 安装 docsify-cli
使用npm安装docsify-cli,命令如下:
```
npm i docsify-cli -g
```
2. 初始化项目
在你的项目根目录下创建一个 docs 文件夹,进入该文件夹并运行以下命令进行初始化:
```
docsify init ./docs
```
3. 配置导航栏和侧边栏
编辑 `index.html` 文件并设置导航栏和侧边栏。导航栏用于在页面上显示所有可访问的文档,而侧边栏则用于在当前文档中显示其它相关文档。你可以通过以下方式设置导航栏和侧边栏:
```
<!-- index.html -->
<nav>
<ul>
<li><a href="#/">Home</a></li>
<li><a href="#/guide">Guide</a></li>
<li><a href="#/api">API</a></li>
</ul>
</nav>
<!-- Sidebar -->
<div class="sidebar">
<ul>
<li><a href="#/guide">Guide</a></li>
<li><a href="#/guide/start">Getting Started</a></li>
<li><a href="#/guide/markdown">Markdown Syntax</a></li>
<li><a href="#/api">API</a></li>
<li><a href="#/api/methods">Methods</a></li>
<li><a href="#/api/events">Events</a></li>
</ul>
</div>
```
4. 编写文档
在 docs 文件夹中编写你的文档,你可以使用 markdown 格式来书写文档,docsify 会自动将其转化为 HTML 页面。
5. 运行 docsify
在项目根目录中执行以下命令:
```
docsify serve docs
```
这将启动本地服务器,并将文档网站部署到 http://localhost:3000 上。
相关推荐
![doc](https://img-home.csdnimg.cn/images/20210720083327.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)