项目文档工具ducute使用简介

最近关注github的trending，发现了一些不错的项目文档管理工具，目前感觉还不错的工具是docute

docute

支持支持编译，内容修改后直接在网页中刷新就能看到最新结果

安装

$ yarn global add docute-cli

快速开始

在项目的根目录执行，在根目录下生成docs目录

$ docute init ./docs

现在可以开始直接在浏览器中预览

$ docute ./docs

配置文档导航

多个文档标签

• 多个标签通过数组来表示
• path中无需包含.md
• 下拉框需要定义标签类型为dropdown

self.$config = {
  nav: [
    { title: '首页', path: '/' },
    { title: '文档2', path: '/文档2' },
    {
      title: 'Languages',
      type: 'dropdown',
      items: [
        { title: 'Chinese', path: '/language/chinese' },
        { title: 'Japanese', path: '/language/japanese' },
      ]
    },
  ]
}

效果图

Paste_Image.png

docsify

试用版本v1.4.3，在Markdown解析及语法高亮这块还是做的不太好，测试了一个简单页面出了好多异常，直接放弃了