@primeton-ui/pmbook v1.1.7

Pmbook

基于vuepress封装的markdown文档系统

安装

npm install @primeton-ui/pmbook -g

如果您不需要pdf导出功能，请安装1.0.17版本

pdf导出功能对windows系统可用版本：1.0.14win版本

pdf导出功能对mac系统可用版本：1.0.14mac版本,并且需要您手动将一个1.20.0版本的puppeteer依赖包（请在其它前端项目中install并在node_modules中寻找）复制到您全局@primeton-ui/pmbook安装位置的node_mudules文件夹下

这是由于pdf导出依赖包1.20.0版本的puppeteer需要系统权限才能安装（mac系统可能会遇到安装失败问题）

使用

pmbook dev

pmbook build

pmbook exportPDF

全局安装pmbook后，完成基本目录、附件配置在文档根目录运行pmbook dev命令即可（可能需要管理员身份运行）

必要的文件

   ├── config                         基本配置文件
       ├── menu 
           ├── menu.js                左侧菜单
           ├── nav.js                 navbar下拉菜单
       ├── config.js 
   ├── public                          附件文件夹
   │   ├── pmbook-logo.svg                 
   ├── dist                            编译产物包

menu.js

export default [{
  'title': '产品文档',
  'children': [{
    'title': '文档说明',
    'path': 'product-doc/introduce',
    'children': [],
  }],
}]

nav.js

export default [
  {
    text: '其他版本',
    items: [
      {
        text: '1.1',
        link: '/1.1/'
      },
      {
        text: '1.2',
        link: '/1.2/'
      }
    ]
  }
]

config.js

import menu from './menu/meun'
import Nav from './menu/nav'

export default {
  // base:'/pmbook/',    基本路径，默认为'/'
  locales: {
    '/': {
      title: 'pmbook',
      description: 'pmbook是一个基于vuepress封装的文档框架，全局安装后可以在任何文档下直接运行、打包',
    },
  },
  themeConfig: {
    sidebar: menu,
    locales: {
      '/': {
        nav: Nav,
      },
    },
    logo: '/pmbook-logo.svg', //logo图片地址对应public文件夹中位值
  },
  paramsConfig:{
    version:'1.1' //变量配置，可以在md文件中通过{{$paramsConfig.version}}引用并显示
    //如需在代码段中使用变量，请使用:::code :::来包裹代码段，而不是惯常使用的``` ```
  }
}