Repolode
docsifyjs

docsifyjs/docsify

一款无需构建过程、可将 Markdown 文件直接转为文档网站的工具。

Star
31,556
Fork
5,784
未关闭 Issue
102
最近提交
3小时前

这是什么?

Docsify 可以将一个或多个 Markdown 文件直接生成为文档网站,无需在构建阶段输出静态 HTML 文件。页面由浏览器端渲染,内容用 Markdown 编写后,放在任意静态服务器或 GitHub Pages 上即可访问,省去编译步骤。

项目体积小,内置全文搜索插件和多套主题,支持 emoji,并提供插件 API 用于扩展站点功能。另有独立的 Docsify CLI 工具,库文件也可通过 UNPKG、jsDelivr、cdnjs 等 CDN 引入。

它适合需要与代码放在同一仓库、通过直接修改 Markdown 来维护的项目文档。

核心功能

  • 01无需构建步骤,直接将 Markdown 渲染为网站
  • 02可部署在任意静态服务器或 GitHub Pages 上
  • 03提供全文搜索插件
  • 04内置多套主题
  • 05提供插件 API 便于定制
  • 06支持 emoji 表情

适用场景

  • 将项目文档与源代码放在同一 Git 仓库中统一维护
  • 在 GitHub Pages 上发布文档站点,无需配置静态站点生成流程
  • 基于已有的 Markdown 笔记快速搭建内部知识库

快速上手

  1. 1

    使用 GitHub 上现成的 Docsify 模板,并通过静态 Web 服务器或 GitHub Pages 提供服务

  2. 2

    阅读官方文档站点上的快速入门教程

标签

常见问题

docsify 是什么?
一款无需构建过程、可将 Markdown 文件直接转为文档网站的工具。 Docsify 可以将一个或多个 Markdown 文件直接生成为文档网站,无需在构建阶段输出静态 HTML 文件。页面由浏览器端渲染,内容用 Markdown 编写后,放在任意静态服务器或 GitHub Pages 上即可访问,省去编译步骤。
docsify 可以免费使用吗?用的什么许可证?
docsify 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
docsify 还在维护吗?
活跃维护中。docsify 最近一次提交是在 2026年10月21日。
docsify 适合用来做什么?
将项目文档与源代码放在同一 Git 仓库中统一维护 在 GitHub Pages 上发布文档站点,无需配置静态站点生成流程 基于已有的 Markdown 笔记快速搭建内部知识库
docsify 怎么安装和运行?
使用 GitHub 上现成的 Docsify 模板,并通过静态 Web 服务器或 GitHub Pages 提供服务 阅读官方文档站点上的快速入门教程
在哪里获取 docsify?
源代码和安装说明在 GitHub 上:https://github.com/docsifyjs/docsify

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目