looplan-doc

[点击查看在线文档]

一款文档工具，用于快速生成文档网站。

• 可以只写markdown, 通过本项目部署文档网站
• 支持 vue组件,html 的 预览 | 复制代码 | 查看代码

用途

• 普通markdown文档
• 编写vue组件库文档
• 编写css样式库文档

功能规划

勾选的表示已经完成，未勾选的表示待开发。

• [x] 文档渲染
• [x] 代码高亮
• [x] 文档配置加载
• [x] vue组件预览
• [x] 生成路由
• [x] 命令行工具-开发模式
• [ ] 命令行工具-打包
• [ ] 命令行工具-云部署
• [x] 自定义插件
• [ ] 插件加载
• [ ] 自定义主页
• [x] 云组件加载
• [ ] 文档搜索
• [ ] 多语言支持
• [ ] 文档主题
• [ ] 外观美化
• [ ] 体积优化(当前加载的highlight.js未做按需加载)

用法

1.编写md文档

• 编写README.md
• looplan-doc会自动解析README.md文件,识别heading生成菜单
• 子菜单的链接，需要使用相对路径，例如./button.md
• 页面需要右侧的导航, 请在头部添加[TOC]

# 文档标题

这是一些对文档的描述

# 菜单

## 样式

- [按钮](./button.md)
- [配置](./config.md)
- [关于](./about.md)

## 组件
* [按钮](./components/button.md)

2.开发模式

# 全局安装cli工具
npm i looplan-cli - g
# 在README.md的目录下执行以下命令, 启动开发服务器
lpc doc dev

3.部署到网站

自动部署的cli命令正在开发中...

• 文档部署到站点
• 下载looplan-doc的dist目录的代码
• dist目录下的代码放到站点根目录

配置nginx

和部署vue前端项目一样

location / {
    try_files $uri $uri/ /index.html last;
    index index.html;
}