简介

Docsify 是一款轻量级、易用的文档网站生成工具

主要特点

• 纯前端：Docsify 是一款纯前端的工具，不需要复杂的后端配置，只需简单的配置和几行 Markdown 格式的文档内容，就可以快速生成漂亮的文档网站。
• 单页应用：Docsify 采用单页应用的方式呈现文档内容，用户可以通过导航菜单或滚动浏览器来浏览文档，具有良好的交互体验。
• 自动侧边栏和导航：Docsify 可以根据 Markdown 文件的目录结构自动生成侧边栏和导航，极大地简化了文档的管理和展示。
• 丰富的插件支持：Docsify 提供了丰富的插件支持，可以扩展其功能，例如支持搜索、支持主题定制、支持代码高亮等。
• 无需静态构建：与 GitBook 不同，Docsify 不会生成静态的 .html 文件，所有转换工作都是在运行时进行，这使得文档的更新和部署更加灵活。
• 轻量级：小巧的体积意味着更快的加载速度，特别是在网络条件不佳的情况下。
• SEO 友好：虽然 Docsify 是单页应用，但它提供了 SEO 支持，帮助你的文档更好地被搜索引擎抓取。
• 多语言支持：对于国际化项目，Docsify 提供了良好的多语言支持。
• 兼容性：兼容 IE11，确保更多用户能够使用。

应用场景

• 项目文档：开源项目的 API 文档、开发者指南和用户手册非常适合用 Docsify 来构建。
• 知识库：企业内部的知识库系统可以借助 Docsify 快速搭建，方便员工查阅。
• 个人博客：对于偏好 Markdown 编辑且不需要复杂功能的博客作者来说，Docsify 是个不错的选择。
• 教程与学习资源：教育领域的课程资料、学习指南可以用 Docsify 进行结构化呈现。

官方资源

• 官网：https://docsify.js.org
• GitHub 开源社区：https://github.com/docsifyjs/docsify
• 官方中文文档：https://docsify.js.org/#/zh-cn

使用方法

要开始使用 Docsify 创建文档网站，你需要遵循以下基本步骤：

安装 Node.js 和 npm

首先，确保你的计算机上安装了 Node.js 和 npm（Node 包管理器），因为 Docsify 是基于 Node.js 的。

初始化项目 创建一个新的目录作为你项目的根目录，并在该目录下初始化一个新的 npm 项目：

mkdir my-docsify-project
cd my-docsify-project
npm init -y

安装 Docsify 通过 npm 安装 Docsify 到你的项目中：

npm install docsify-cli -g

-g 标志表示全局安装，这样你可以在任何地方使用 docsify 命令。

初始化 Docsify 在项目根目录下初始化 Docsify：

docsify init ./ 

这将会在当前目录下创建一些必要的文件和文件夹，包括一个 index.html 文件。

启动本地服务器 为了查看你的文档网站，可以使用如下命令启动一个本地服务器：

docsify serve .

这将启动一个本地开发服务器，默认情况下可以在 http://localhost:3000 访问。

编写文档

现在你可以在 /docs 目录下添加 .md 文件来编写文档内容。Docsify 会自动读取这些文件并在访问时渲染它们。

配置

你可以通过编辑 index.html 文件中的