关于sfossp:思否开源项目推介丨docsify一个神奇的文档网站生成器

开源项目名称：docsify
开源我的项目负责人：@Cinwell、@沈唁
开源我的项目简介：一个神奇的文档网站生成器
开源我的项目类型：集体开源我的项目
我的项目创立工夫：2016 年
GitHub 数据：15.4k Star，2.7k Fork
GitHub 地址：https://github.com/docsifyjs/docsify

我的项目介绍

docsify 是一个神奇的文档网站生成器。能够疾速帮你生成文档网站。不同于 GitBook、Hexo 的中央是它不会生成动态的 .html 文件，所有转换工作都是在运行时。如果你想要开始应用它，只须要创立一个 index.html 就能够开始编写文档并间接部署在 GitHub Pages 等中央。

无论开源我的项目还是外部我的项目，在开发我的项目时，想要应用 Markdown 构建文档，将文档对立治理，docsify 是不错的抉择。无需构建和编译，写完 Markdown 就能够间接公布。

个性

• 无需构建，写完文档间接公布
• 容易应用并且轻量 (压缩后 ~21kB)
• 智能的全文搜寻
• 提供多套主题
• 丰盛的 API
• 反对 Emoji
• 兼容 IE11
• 反对服务端渲染 SSR (示例)

思否举荐

技术人员在实现我的项目或者对接我的项目时须要去写一些我的项目手册，记录开发中的流程、应用办法以及一些注意事项。部署结束后分享给与我的项目相干的共事，以进步合作效率。尽管说在线文档能实现这项工作，然而在线文档对于代码、公式的展现远远不如纯 Markdown 的编辑，这时候能够抉择 docsify 这类的工具来进行文档部署。以下几点是 docsify 做的比拟好的：

1. Markdown 书写，托管在 Github 上，能够本人轻松自定义域名
2. Markdown 中的题目主动生成目录
3. 整体页面的配色和布局舒服易读

如果你有本人部署文档分享的需要，不如试试 docsify 吧。

该我的项目已入选「SFOSSP – 思否开源我的项目反对打算」，咱们心愿借助社区的资源对开源我的项目进行相干的宣传推广，并作为一个长期我的项目助力开源事业的倒退，与宽广开发者共建开源新生态。
有动向的开源我的项目负责人或团队成员，可通过邮箱（pr@segmentfault.com）提供相应的信息（开源我的项目地址、我的项目介绍、团队介绍、联系方式等），以便晋升交换的效率。