Docsify 简介

来自泡泡学习笔记
跳到导航 跳到搜索

一个神奇的文档网站生成器。

概述

docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。

查看快速开始了解详情。

特性

  • 无需构建,写完文档直接发布
  • 容易使用并且轻量 (压缩后 ~21kB)
  • 智能的全文搜索
  • 提供多套主题
  • 丰富的 API
  • 支持 Emoji
  • 兼容 IE11
  • 支持服务端渲染 SSR (示例)

示例

可以查看 Showcase 来了解更多在使用 docsify 的文档项目。

捐赠

如果你觉得 docsify 对你有帮助,欢迎给作者捐赠

社区

Discord 的社区里可以找到 docsify 的用户和开发者团队。