这是一个基于 Ant Design Vue
、Marked.js
和 Highlight.js
开发的文档模块,用于快速构建文档。
- 纯静态,不依赖数据库,开箱即用
- Markdown 语法解析 + 支持代码高亮
- 自动根据标题生成多级锚点链接,支持快速跳转
将 Markdown 文档放入 doc
目录,如:
doc/doc1.md
doc/doc2.md
doc/doc3.md
doc/doc4.md
doc/doc5.md
doc/doc6.md
在 config.json
中配置标题及菜单,如:
{
"title": "文档模块", // 标题名称
"menu": [
{
"title": "父级菜单 1", // 父级菜单名称
"icon": "folder", // 父级菜单图标(图标地址:https://antdv.com/components/icon-cn/)
"child": [
{
"title": "子级菜单 1", // 子级菜单名称
"key": "doc1" // 子级菜单文档名称(doc/doc1.md)
},
{
"title": "子级菜单 2",
"key": "doc2"
}
]
},
{
"title": "父级菜单 2",
"icon": "heart",
"child": [
{
"title": "子级菜单 3",
"key": "doc3"
},
{
"title": "子级菜单 4",
"key": "doc4"
}
]
},
{
"title": "父级菜单 3",
"icon": "bulb",
"child": [
{
"title": "子级菜单 5",
"key": "doc5"
},
{
"title": "子级菜单 6",
"key": "doc6"
}
]
}
]
}