A fast and light Document Creator 一个轻快的文档生成器
- 这是一个基于vite的文档生成器插件
- 快速生成文件界面源码
- 编辑markdown生成html页面
- 快速生成文档菜单
- 依赖vite编译环境
- 插件内自动依赖marked、highlightjs
- 创建工程文件夹
mkdir project-name
- 进入文件夹初始化npm
npm init -y
npm i vite -D
- 修改package.json内部的scripts命令
"scripts": {
"dev": "vite",
"build": "vite build"
}
- 安装vite-doc-creator。作者:小野森森
npm i vite-doc-creator -D
- 工程文件夹根目录下创建vite.config.js
touch vite.config.js
- vite.config.js配置插件
const ViteDocCreator = require('vite-doc-creator');
module.exports = {
plugins: [new ViteDocCreator()]
}
npm run dev
- 配置项位置
module.exports = {
plugins: [new ViteDocCreator({
// 配置项
})]
}
- 配置项说明
配置项 | 说明 | 默认值 | 必填 |
---|---|---|---|
title | 网页title与header文字标题 | This is my first DOC by Vite-doc-creator | 否 |
domain | 生产环境下的域名(须带协议:http://或https://) | http://localhost | 否 |
port | 生成环境下的端口号 | process.env.npm_config_port | 否 |
注意:为了避免页面链接生成错误,请尽量不要在开发环境下设置domain与port,除非确保文档页面在该域名或该端口下可以正常访问。
- 在workspace文件夹中创建.md文件进行编辑
- 保存.md文件后,会自动将文件转换为html文件并生成文件菜单
- 页面会自动展示,无需刷新页面
- 目前不支持在workspace内创建子文件夹(稍后更新会支持)
- 目前不支持修改workspace内的md文件名(稍后更新会支持)
20201009:v1.0.0
- 创建文档工程目录 src -> js css html workspace
- 创建文件 复制:js/css/welcome.html 编译:index.html / md.html createIndexHtml mdToHtml
- 监听文件及文件夹变化 watchHtml / watchMarkdown 监听html文件夹 监听workspace文件夹