QQ 群:45686341
BaseSDD 是基于 vuepress 开发、mackdown 编辑的文档、记录、api,解决方案 搜索站点 探针深度 ### 即 h1 h2 h3 的深度 3 级导航
下载代码后 需要先行安装 vuepress
npm install -g vuepress
安装相关环境
// 在项目 根目录下
npm install
运行 npn run dev 启动服务 打开:localhost:8080 即可查看
/01fsr 可行性研究报告
/02mdp 模块开发卷宗
/03opm 操作手册
/04sum 用户手册
/05dsr 软件需求说明书
/06gds 概要设计说明书
/07dds 详细设计说明书
/08dts 数据要求说明书
/09ddm 数据库设计说明书
/10pdp 项目开发计划
/11mdpr 开发进度月报
/12ttp 测试计划
/13tar 测试分析报告
/14pim 项目实施说明书
/15pdsr 项目开发总结报告
原则上以语言、架构为创建文件夹的依据,如果如 vue、vue-router、vuex 这样的将统一放到 vue 文件夹下 新开分组进行编写
尽量将标题 api 的主项保持在 3 级分类内 以便搜索
docs 下边创建相应的文件夹
在 .vuepress/config.js 中配置如下示例
创建完成后 需要将路径配置到网站的主页 也就是 home 页面 home 页面为 docs/README.md 如没有相应分类 可添加一个分类
'/html/': [
{
title: '基础',
collapsable: false,
children: genHtmlEssentialsSidebar()
},
{
title: '进阶',
collapsable: false,
children: genHtmlAdvancedSidebar()
},
{
title: '其它',
collapsable: false,
children: [
]
}
],
// TODO: html 对外路径配置
function genHtmlEssentialsSidebar(type = '') {
const mapArr = [
'/html/',
'/html/essentials/essentials.md',
]
return mapArr.map(i => {
return type + i
})
}
function genHtmlAdvancedSidebar(type = '') {
const mapArr = [
'/html/advanced/advanced.md',
]
return mapArr.map(i => {
return type + i
})
}
Generator by vuepress
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )