前言
因为公司最近要为项目做一个能在线预览的操作使用说明文档,于是网上找以下了一下常用的几款动态文档生成工具...
Docsify
docsify可以即时生成文档网站,它可以智能地加载和解析您的Markdown文件并将其显示为网站,但是它不会生成静态html文件, SEO 不够友好。使用简单,支持ie10以上浏览器。官方推荐部署到GitHub Pages上,它也支持服务端渲染。因为服务端渲染麻烦(我不会...)和浏览器不能兼容ie9的原因我放弃了他选择了vuepress,但总的来说使用起来还是很方便,界面也可以,还是比较值得推荐的。
VuePress
Vue 驱动的静态网站生成器。跟Docsify一样也是以Markdown为中心的项目结构,但是它可以为每个页面预渲染生成静态的html页面,可以通过vue去自定义主题,浏览器支持ie9及以上浏览器,上手程度相对于Docsify要难点,但是部署简单,功能也蛮强大的我最终也选择了它。吐槽一下:左侧导航只支持3级栏目导航(h1-h3),没有Docsify灵活。
官方中文网:https://www.vuepress.cn/
Docute
Docute和Docsify差不多,但是它不支持ie...,如果不考虑ie兼容性问题的可以参考一下
官方中文网:https://docute.org/zh/
Hexo
也是使用Markdown解析文章,能够兼容ie9,但是它是一个博客框架,它主题样式不太适用于帮助文档,所以我没有考虑它,单从文档网站的角度的话还是推荐使用的,兼容性比较好,上手度简单。
官方链接:https://hexo.io/
GitBook
GitBook是一款文档编辑工具,单据说更像是一个现代的文档平台,无法实现个性化部署,所以暂时没有考虑。
官网链接:http://caibaojian.com/gitbook/
Nuxt
Nuxt.js 是一个基于 Vue.js 的通用应用框架,vuepress能做的,它理论上能做,但是Nuxt 是为构建应用程序而生的,VuePress则专注以内容为中心的静态网站,所以就文档网站我更推荐VuePress
官网链接: https://www.nuxtjs.cn/