@vsmi/api-docs

文档使用指南

一个简单的基于markdown的文档生成工具，支持JS代码转换执行，生成静态站点

开始使用

安装依赖

npm i @vsmi/md-loader @vsmi/api-docs @vsmi/docs-generator --save-dev

添加文档配置

const path = require('path');
module.exports = {
  // 文档标题、logo信息
  inject: {
    title: '微风开发文档',
    logo: '',
  },
  // 配置文档扫描的基准目录，控制到最小，降低信息消耗
  cwd: path.resolve(__dirname, './src'),
  // 文档入口路由信息
  groups: [
    {
      // 排序，越小越靠前
      order: 2,
      // 用于显示标题
      title: '组件',
      // 分组路由
      route: '/components',
      // 分组路由对应的文档目录（相对于 cwd）
      basePath: './components',
    },
  ],
  // 文档开发端口，默认为 8020
  port: 9001,
  // webpack 配置处理
  webpack(config) {
    
  }
};

运行脚本

在 package.json中添加script

{
  "scripts": {
    "docs:start": "hp-docs start",
    "docs:build": "hp-docs build"
  }
}

开发阶段

默认会打开一个开发服务器

npm run docs:start

生成静态端点

生成到 sites 目录

npm run docs:build

文档编写

其中头部信息为文档生成提供元信息，以三个hr 标记分开；

属性	必填	类型	描述	默认值
title	yes	string	显示的标题信息	-
cate	no	string	为当前文档所属分组， 不存在时则显示为根目录	-
order	no	number	文档目录的顺序,越小越靠前	-
toc	yes	boolean	控制是否文档显示在目录中	false
only	yes	boolean	不解析代码块	false

---
order: 2
cate: 基本使用
title: 测试DEMO
toc: false
timeline: true

---
这是一个基本描述信息, 哈哈~~

---

正文信息....
正文信息....
正文信息....

LICENSE

MIT