推荐一个神奇的网站文档生成器,Docsify,https://t.co/WogEiEQtNl。如果你的项目 Repo 写了一个 README,或者写了一堆 Markdown 文件,正准备使用 GitBook、Hexo、Jekyll 等工具来生成一个网站,可以考虑停下来,先看看这个工具。
你需要做的工作十分简单,在项目中增加一个 index.html 文件,写十几行代码然后稍作配置,就可以搞定你的网站文档站点了,对程序员极为友好。它的原理比较简单:
1)搭建一个网页初始化框架,允许网站主题、字体、字号、Logo 等进行配置化传入
2)然后直接异步加载 Markdown 文件,解析成 HTML 后呈现
3)同时允许对 sidebar/navbar/pagecover 等框架性的东西做定制化,并以插件化的方式支持了社区化评论组件、Google 统计、代码预览等等的接入
功能做的颇为全面,大多数情况下,默认的几个配置就可以满足需求了。
点击图片查看原图
点击图片查看原图