https://github.com/docsifyjs/docs-zh

docsify 中文文档
https://github.com/docsifyjs/docs-zh

docsify

Last synced: about 8 hours ago
JSON representation

docsify 中文文档

• Host: GitHub
• URL: https://github.com/docsifyjs/docs-zh
• Owner: docsifyjs
• License: mit
• Created: 2018-07-01T11:19:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-24T05:35:36.000Z (6 months ago)
• Last Synced: 2024-10-30T00:00:30.300Z (10 days ago)
• Topics: docsify
• Homepage: https://docsify.js.org/#/zh-cn/
• Size: 69.3 KB
• Stars: 318
• Watchers: 5
• Forks: 907
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## docsify

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

## 概述

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

查看[快速开始](zh-cn/quickstart.md)了解详情。

## 特性

- 无需构建，写完文档直接发布

- 容易使用并且轻量 (压缩后 ~21kB)

- 智能的全文搜索

- 提供多套主题

- 丰富的 API

- 支持 Emoji

- 兼容 IE11

- 支持服务端渲染 SSR ([示例](https://github.com/docsifyjs/docsify-ssr-demo))

## 示例

可以查看 [Showcase](https://github.com/docsifyjs/docsify/#showcase) 来了解更多在使用 docsify 的文档项目。

## 捐赠

如果你觉得 docsify 对你有帮助，或者想对我微小的工作一点资瓷，欢迎给我[捐赠](https://github.com/QingWei-Li/donate)。

## 社区

在 [Discord](https://discord.gg/3NwKFyR) 的社区里可以找到 docsify 的用户和开发者团队。