docs-template

vue-docs-template

一个基于 Element-ui 风格的文档模板。 渲染 Markdown 中写的 vue 的代码。

• Markdown 文件

:::demo
<template>
  <div>devider component</div>
</template>
:::

• 渲染结果

Project setup

yarn install

Compiles and hot-reloads for development

yarn run serve

Compiles and minifies for production

yarn run build

Run your tests

yarn run test

Lints and fixes files

yarn run lint

release log

yarn run release

Markdown 文件中使用到的 Vue 组件需要在 src/main.js 中注册

• src/main.js

import Star from '@/packages'

Vue.use(Star)

• packages/index.js

import Divider from './divider'

const install = Vue => {
  Vue.component(Divider.name, Divider)
}

export default {
  install
}

组件路由设置

模板中的组件路由根据 nav.config.json 文件生成