/doc-website

markdown doc website

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

文档官网

文档目录结构说明

  • doc 文件夹下建立各自组文件夹xxx,在doc/SUMMARY.md中增加组文夹名字xxx,即可展示在页面右上角分类。
  • 组文件夹下建立SUMMARY.md文件并编辑,作为此组目录分类导航,展示在页面左侧导航栏。
  • 组文件夹中建立相应目录和文档,并将相对地址写入SUMMARY.md中进行导航链接展示。
  • 详细翻看 doc 文件夹举例。

运行预览

npm install
npm run dev

或者

yarn install
yarn run dev

打开:localhost:3080

运行效果

img

参考文献