---

• 💂 个人网站: IT知识小屋
• 🤟 版权: 本文由【IT学习日记】原创、在CSDN首发、需要转载请联系博主
• 💬 如果文章对你有帮助、欢迎关注、点赞、收藏(一键三连)和订阅专栏哦

---

简介

Docsify是一款基于JavaScript的轻量级文档网站生成工具，专为构建优雅、响应迅速的静态文档网站而设计。与传统的静态站点生成器的实现原理不同，Docsify无需经过预编译过程，可按需加载Markdown文件并动态渲染为网站页面，让文档部署变得更轻松高效。

因其轻量、易用、无需构建的特性，Docsify被广泛应用于许多开源项目、技术团队和个人开发者的文档站点中，一些知名网站如下：

• Leetcode-Notes：Github上获得超过75k Star的算法动画解析项目

• Python-100-Days：Github上获得超过166k Star的Python学习百日计划项目

• Egg：阿里巴巴开源的企业级 Node.js框架，其社区文档项目使用Docsify构建

• 个人网站：需要基于Github Page搭建而成的个人网站，使用Docsify构建

---

特点

• 无需构建： 无需生成HTML文件，部署只需一个HTML页面，写完文档直接发布

• 即插即用： 只需引入一个 JS 脚本，即可快速启动项目

• 支持Markdown： 原生支持Markdown语法，书写简单清晰

• 全文搜索： 内置搜索插件，轻松定位文档内容

• 主题切换： 支持多种主题风格及暗黑模式

• 丰富插件系统： 可扩展性强，支持多种第三方插件如：图片缩放、代码实时预览、代码高亮、文章字数实时统计等

• 移动端友好： 响应式设计，适配手机、平板等设备

• 多语言支持： 可配置多语言版本，满足国际化需求

---

应用场景

Docsify支持实时渲染，可以将文件部署到GitHub Pages、GitLab Pages或VPS上，常见的应用场景如下：

• 开源项目的技术文档

• API接口文档

• 内部知识库

• 个人网站或者企业静态网站

• 教程和用户手册

---

UI界面

---

快速上手

初始化项目：如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目

docsify init ./docs

写入内容：在 init 完成后，你可以看到 ./docs 子目录中的文件列表。

index.html 入口文件

README.md 会做为主页内容渲染

.nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新文档内容，当然也可以添加更多页面。

本地预览：使用 docsify serve 运行本地服务器。 你可以在 http://localhost:3000 上预览你的网站

docsify serve docs

---

开源地址&使用手册

点击下方的【IT学习日记】回复【资源】领取！

如果这篇文章对您有帮助，请一定帮我点个 “关注” 和 “点赞”,这对我非常重要。我将会继续推荐更多优质项目和新闻。

写在最后

1000+优质开源项目更新进度：215/1000。如需更多类型优质项目推荐，请在文章后留言。