思否开源项目推介丨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)提供相应的信息(开源项目地址、项目介绍、团队介绍、联系方式等),以便提升交流的效率。

clipboard.png

阅读 9.4k

SegmentFault_行业快讯
第一时间为开发者提供行业相关的实时热点资讯

思否编辑部官方账号,欢迎私信投稿、提供线索、沟通反馈。

3.3k 声望
105.4k 粉丝
0 条评论

思否编辑部官方账号,欢迎私信投稿、提供线索、沟通反馈。

3.3k 声望
105.4k 粉丝
文章目录
宣传栏