思否开源项目推介丨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 等地方。html
不管开源项目仍是内部项目，在开发项目时，想要使用 Markdown 构建文档，将文档统一管理，docsify 是不错的选择。无需构建和编译，写完 Markdown 就能够直接发布。git
特性
- 无需构建，写完文档直接发布
- 容易使用而且轻量 (压缩后 ~21kB)
- 智能的全文搜索
- 提供多套主题
- 丰富的 API
- 支持 Emoji
- 兼容 IE11
- 支持服务端渲染 SSR (示例)
思否推荐
技术人员在完成项目或者对接项目时须要去写一些项目手册，记录开发中的流程、使用方法以及一些注意事项。部署完毕后分享给与项目相关的同事，以提升协做效率。虽说在线文档能完成这项工做，可是在线文档对于代码、公式的展现远远不如纯 Markdown 的编辑，这时候能够选择 docsify 这类的工具来进行文档部署。如下几点是 docsify 作的比较好的：github
- Markdown 书写，托管在 Github 上，能够本身轻松自定义域名
- Markdown 中的标题自动生成目录
- 总体页面的配色和布局温馨易读
若是你有本身部署文档分享的需求，不如试试 docsify 吧。segmentfault
该项目已入选 「SFOSSP - 思否开源项目支持计划」，咱们但愿借助社区的资源对开源项目进行相关的宣传推广，并做为一个长期项目助力开源事业的发展，与广大开发者共建开源新生态。
有意向的开源项目负责人或团队成员，可经过邮箱（pr@segmentfault.com）提供相应的信息（开源项目地址、项目介绍、团队介绍、联系方式等），以便提高交流的效率。
