文档管理工具

Docsify:

简介:

Docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。Docsify是基于 Vue,完全的运行时驱动,不需要渲染html,所以对 SEO 不够友好。如果不关注 SEO,安装简单化不想有大量依赖,他是比较好的选择,比如公司或这团队内部的文档系统。

特性:
1.无需构建,写完文档直接发布
2.容易使用并且轻量 (~19kB gzipped)
3.智能的全文搜索
4.提供多套主题
5.丰富的 API
6.支持 Emoji
7.兼容 IE10+
8.支持 SSR

9.支持离线渲染

拓展性:

 1.支持自定义插件

 2.兼容vue

 3.最新功能支持文件的嵌入

维护团队:

 Docsify是由现饿了么前端团队@elemeFE的cinwell.li编写的一套文档站点生成框架,github上已有3k+ star。

Vuepress

简介:

VuePress 由两部分组成:第一部分是一个极简静态网站生成器,它包含由 Vue 驱动的主题系统和插件 API,另一个部分是为书写技术文档而优化的默认主题,它的诞生初衷是为了支持 Vue 及其子项目的文档需求。

每一个由 VuePress 生成的页面都带有预渲染好的 HTML,也因此具有非常好的加载性能和搜索引擎优化(SEO)。同时,一旦页面被加载,Vue 将接管这些静态内容,并将其转换成一个完整的单页应用(SPA),其他的页面则会只在用户浏览到的时候才按需加载。实际上一个 VuePress 网站是一个由 Vue、Vue Router 和 webpack 驱动的单页应用。

特性:

  1.内置 markdown 扩展,针对技术文档进行了优化

 2.能够利用内嵌在 markdown 文件中的 Vue 代码
 3.以 Vue 驱动的自定义主题系统
 4.PWA 支持
 5.Google Analytics 集成
 6.一个默认主题:
        响应式布局
       可选的主页
       简单、开箱即用、基于标题的搜索功能
       可定制的导航栏和侧边栏
       自动生成的 GitHub 链接和页面编辑链接

拓展性:

1.支持markdown语法的的拓展

2.支持在markdown使用vue

3.支持markdown插槽:VuePress 实现了一套针对 Markdown 的内容分发 API。通过这个特性,你可以将你的文档分割成多个片段,以便于在布局组件中灵活组合。

维护团队:

 Vuepress是 Vue 的作者 Evan You 为了方便文档的编写而开发的,维护团队为Vue团队。

docusaurus

taro项目的时候发现一个好用的文档管理工具, 就在vue源码解读的项目中试用了下

npm install --global docusaurus-init
npm install docusaurus --save-dev
// root-directory
docusaurus-init

步骤戳-> 文档

我们发现这个website是react编写的,不如在这个项目里面构建一个react工程,支持typescript,

cnpm install typescript --save-dev

@vuedoc/md

clipboard.png

vuejs/vuepress

阅读 480

推荐阅读
镜心的小树屋
用户专栏

方寸湛然GitHub组织地址:[链接]

47 人关注
123 篇文章
专栏主页