该项目是一个vitepress引擎+Vue3渲染的文档官网页搭建模板
git clone https://gitee.com/FnTop/acri-doc-source.git- if no have yarn ,you can install by npm. eg :
npm install yarn. yarn installyarn dev- if happen error,you can ignore. eg :
yarn config set ignore-engines true yarn buildfor production. and you can test build byyarn serve
- docs // 文档核心目录 - .vitepress - cache // vitepress项目默认生成 - dist // yarn build 生成的。发布生产时的资源文件 - theme // 首页主题图标样式配置 - style - var.css // 图标渐变色配置核心文件 - index.ts - confing.ts // 文档配置核心文件 - guide // 存放指南对应的所有页面 - index.md - version.md - public // 静态资源目录 - index.md // 文档首页配置页面 - deploy.sh // 发布dist文档内容到gitee - deployall.sh // 发布整个项目到gitee - package-locak.json // 默认生成 - package.json // 默认生成 - README.md // 项目文档 - yarn.lock // 默认生成
| 配置项 | 说明 |
|---|---|
| 浏览器tab logo配置 | head: [ ['link', { rel: 'icon', href: '/acri-doc/logo.ico' }] ] |
| 站点配置 | base: '/acri-doc/' |
| 是否显示最新更新时间 | lastUpdated: true |
| 是否显示代码行号 | markdown: { lineNumbers: true // 显示行号 } |
| 主题配置 | themeConfig:{} |
| 配置项 | 说明 |
|---|---|
| 返回顶部内容 | returnToTopLabel: '返回顶部' |
| 右侧大纲文本配置 | outline: { level: "deep", label: "目录", } |
| 首页社交配置 | socialLinks: [{ icon: 'github', link: "https://github.com" }], |
| 上次更新文本配置 | lastUpdatedText: '上次更新', |
| 页脚配置 | footer: { message: 'Released 1.3.0 ', copyright: 'Copyright © 2023 Acri' } |
| 头部导航配置 | nav: [ { text: '首页', link: '/' }, { text: '指南', link: '/guide/', activeMatch: '/guide' } ], |
| 左边导航配置 | sidebar: { '/guide/': [ { text: '指南', items: [ { text: '文档', link: '/guide/' }, { text: 'AOP切面', link: '/guide/aop' }, ] } ] } |
| 文档页脚配置 | docFooter: { prev: '上一篇', next: '下一篇' } |