Merge pull request #23 from MultipledMe/test/icon-refactor
Test/icon refactor
@ -5,11 +5,11 @@ import {defineNavbarConfig} from 'vuepress-theme-plume'
|
|||||||
export const navbar = defineNavbarConfig([
|
export const navbar = defineNavbarConfig([
|
||||||
{text: '首页', link: '/'},
|
{text: '首页', link: '/'},
|
||||||
{
|
{
|
||||||
icon: '/note.svg',
|
icon: '/icon/note.svg',
|
||||||
text: '学习笔记',
|
text: '学习笔记',
|
||||||
items: [
|
items: [
|
||||||
{icon: '/note.svg',text: '前言',link: '/learning-notes/'},
|
{icon: '/icon/note.svg',text: '前言',link: '/learning-notes/'},
|
||||||
{icon: '/AI.svg', text: '机器学习', link: '/learning-notes/ml/'},
|
{icon: '/icon/AI.svg', text: '机器学习', link: '/learning-notes/ml/'},
|
||||||
{icon: 'logos:google-developers', text: '前端开发', link: '/learning-notes/frontend-dev/'},
|
{icon: 'logos:google-developers', text: '前端开发', link: '/learning-notes/frontend-dev/'},
|
||||||
{icon: 'fluent-color:data-scatter-32', text: '后端开发', link: '/learning-notes/backend-dev/'},
|
{icon: 'fluent-color:data-scatter-32', text: '后端开发', link: '/learning-notes/backend-dev/'},
|
||||||
{icon: 'devicon:ros', text: 'ROS2', link: '/learning-notes/ROS2/'},
|
{icon: 'devicon:ros', text: 'ROS2', link: '/learning-notes/ROS2/'},
|
||||||
@ -17,16 +17,16 @@ export const navbar = defineNavbarConfig([
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: '/project.svg',
|
icon: '/icon/project.svg',
|
||||||
text: '项目文档',
|
text: '项目文档',
|
||||||
items: [
|
items: [
|
||||||
{icon: 'carbon:license-third-party', text: '项目知识产权', link: '/project-docs/project-intellectual-property/'},
|
{icon: 'carbon:license-third-party', text: '项目知识产权', link: '/project-docs/project-intellectual-property/'},
|
||||||
{icon: 'hugeicons:add-team', text: '全国大学生竞赛组队系统', link: '/project-docs/match-competitions/'},
|
{icon: 'hugeicons:add-team', text: '全国大学生竞赛组队系统', link: '/project-docs/match-competitions/'},
|
||||||
{icon: '/zhiyu.png', text: '植愈:AI情绪小帮手', link: '/project-docs/plant-cure/'},
|
{icon: '/icon/zhiyu.png', text: '植愈:AI情绪小帮手', link: '/project-docs/plant-cure/'},
|
||||||
{icon: '/robot.png', text: '智慧中草药生态养护平台', link: '/project-docs/smart-car/'},
|
{icon: '/icon/robot.png', text: '智慧中草药生态养护平台', link: '/project-docs/smart-car/'},
|
||||||
{icon: '/univ-town.svg', text: '像素大学城', link: '/project-docs/pixel-university-town/'},
|
{icon: '/icon/univ-town.svg', text: '像素大学城', link: '/project-docs/pixel-university-town/'},
|
||||||
{icon: '/command_block.gif', text: 'CQMUA服务器中心', link: '/project-docs/cqmua-center/'},
|
{icon: '/icon/command_block.gif', text: 'CQMUA服务器中心', link: '/project-docs/cqmua-center/'},
|
||||||
{icon: '/analyse.svg',text: '学情分析系统',link: '/project-docs/study-analytic-system/'},
|
{icon: '/icon/analyse.svg',text: '学情分析系统',link: '/project-docs/study-analytic-system/'},
|
||||||
{icon: 'line-md:speed-twotone-loop',text: '掌中方圆',link: '/project-docs/control-my-panel/'},
|
{icon: 'line-md:speed-twotone-loop',text: '掌中方圆',link: '/project-docs/control-my-panel/'},
|
||||||
{icon: 'icon-park:transport', text: 'SPD智能医疗耗材管理系统', link: '/project-docs/spd/'},
|
{icon: 'icon-park:transport', text: 'SPD智能医疗耗材管理系统', link: '/project-docs/spd/'},
|
||||||
{icon: 'material-symbols:dropper-eye-outline-sharp', text: '医智慧眼', link: '/project-docs/see-the-components/'},
|
{icon: 'material-symbols:dropper-eye-outline-sharp', text: '医智慧眼', link: '/project-docs/see-the-components/'},
|
||||||
@ -38,25 +38,25 @@ export const navbar = defineNavbarConfig([
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: '/code.svg',
|
icon: '/icon/code.svg',
|
||||||
text: 'CS-DIY',
|
text: 'CS-DIY',
|
||||||
items: [
|
items: [
|
||||||
{icon: '/code.svg',text: '前言', link: '/cs-diy/'},
|
{icon: '/icon/code.svg',text: '前言', link: '/cs-diy/'},
|
||||||
{icon: 'mdi:tools', text:'必学工具', link: '/csdiy/tools-must/'},
|
{icon: 'mdi:tools', text:'必学工具', link: '/csdiy/tools-must/'},
|
||||||
{icon: 'carbon:cics-program', text:'编程入门', link: '/csdiy/program-begin/'},
|
{icon: 'carbon:cics-program', text:'编程入门', link: '/csdiy/program-begin/'},
|
||||||
{icon:'/dev-standard.svg', text: '开发规范' , link: '/csdiy/dev-rules/'},
|
{icon: '/icon/dev-standard.svg', text: '开发规范' , link: '/csdiy/dev-rules/'},
|
||||||
{icon: '/path.svg', text: '学习路线', link: '/csdiy/study-path/'},
|
{icon: '/icon/path.svg', text: '学习路线', link: '/csdiy/study-path/'},
|
||||||
{icon: 'fa6-solid:computer',text: '计算机常识', link: '/csdiy/computer-common-knowledge/'}
|
{icon: 'fa6-solid:computer',text: '计算机常识', link: '/csdiy/computer-common-knowledge/'}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: '/public-service.svg',
|
icon: '/icon/public-service.svg',
|
||||||
text: '公共服务',
|
text: '公共服务',
|
||||||
items: [
|
items: [
|
||||||
{icon: '/openai.svg',text: '生成式人工智能',link: '/public-service/GPT/'},
|
{icon: '/icon/openai.svg',text: '生成式人工智能',link: '/public-service/GPT/'},
|
||||||
{icon: 'fluent-color:data-area-20', text: '数据中心', link: '/public-service/data-center/'},
|
{icon: 'fluent-color:data-area-20', text: '数据中心', link: '/public-service/data-center/'},
|
||||||
{icon: '/mirror.svg', text: '重庆医科大学开源软件镜像站', link: '/public-service/cqmu-mirror/'},
|
{icon: '/icon/mirror.svg', text: '重庆医科大学开源软件镜像站', link: '/public-service/cqmu-mirror/'},
|
||||||
{icon: '/overleaf.svg', text: 'Overleaf LaTeX协作编辑器', link: '/public-service/overleaf/'},
|
{icon: '/icon/overleaf.svg', text: 'Overleaf LaTeX协作编辑器', link: '/public-service/overleaf/'},
|
||||||
{icon: 'fluent-emoji-flat:medical-symbol', text: '全球医学公开数据网', link: '/public-service/global-medical-open-data-web/'},
|
{icon: 'fluent-emoji-flat:medical-symbol', text: '全球医学公开数据网', link: '/public-service/global-medical-open-data-web/'},
|
||||||
{icon: 'vscode-icons:file-type-word' ,text: '文书及申报资料网', link: '/public-service/official-documents-web/'},
|
{icon: 'vscode-icons:file-type-word' ,text: '文书及申报资料网', link: '/public-service/official-documents-web/'},
|
||||||
{text: '', link: ''},
|
{text: '', link: ''},
|
||||||
@ -64,40 +64,40 @@ export const navbar = defineNavbarConfig([
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: '/wiki.svg',
|
icon: '/icon/wiki.svg',
|
||||||
text: '大学百科',
|
text: '大学百科',
|
||||||
items: [
|
items: [
|
||||||
{icon: '/email.svg', text: '申请学生邮箱', link: '/campus-wiki/apply-student-email/'},
|
{icon: '/icon/email.svg', text: '申请学生邮箱', link: '/campus-wiki/apply-student-email/'},
|
||||||
{icon: '/teacher.svg', text: '老师们说', link: '/campus-wiki/teacher-talks/'},
|
{icon: '/icon/teacher.svg', text: '老师们说', link: '/campus-wiki/teacher-talks/'},
|
||||||
{icon: 'carbon:container-software', text: '常用软件', link: '/campus-wiki/common-softwares/'},
|
{icon: 'carbon:container-software', text: '常用软件', link: '/campus-wiki/common-softwares/'},
|
||||||
{icon: '/cert.svg', text: '证书及技能考试', link: '/campus-wiki/credential-skillful-exams/'},
|
{icon: '/icon/cert.svg', text: '证书及技能考试', link: '/campus-wiki/credential-skillful-exams/'},
|
||||||
{icon: 'ic:baseline-school',text: '校内生活', link: '/campus-wiki/campus-life/'},
|
{icon: 'ic:baseline-school',text: '校内生活', link: '/campus-wiki/campus-life/'},
|
||||||
{icon: '/competition.svg', text:'竞赛篇', link: '/campus-wiki/competition/'},
|
{icon: '/icon/competition.svg', text:'竞赛篇', link: '/campus-wiki/competition/'},
|
||||||
{icon: '/kaoyan.svg', text:'考研篇', link: ''},
|
{icon: '/icon/kaoyan.svg', text:'考研篇', link: ''},
|
||||||
{icon: '/kaogong.svg', text:'考公篇', link: ''},
|
{icon: '/icon/kaogong.svg', text:'考公篇', link: ''},
|
||||||
{icon: '/baoyan.svg', text:'保研篇', link: ''},
|
{icon: '/icon/baoyan.svg', text:'保研篇', link: ''},
|
||||||
{icon: '/liuxue.svg', text:'留学篇', link: ''},
|
{icon: '/icon/liuxue.svg', text:'留学篇', link: ''},
|
||||||
{icon: '/internship.svg', text:'实习篇', link: ''},
|
{icon: '/icon/internship.svg', text:'实习篇', link: ''},
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: '/manage.svg',
|
icon: '/icon/manage.svg',
|
||||||
text: '后台管理',
|
text: '后台管理',
|
||||||
items: [
|
items: [
|
||||||
{icon: '/OAuth2.svg', text: 'OAuth登录(测试版)', link: 'https://hrtcsm.logto.app/demo-app'},
|
{icon: '/icon/OAuth2.svg', text: 'OAuth登录(测试版)', link: 'https://hrtcsm.logto.app/demo-app'},
|
||||||
{icon: 'icon-park:data-lock', text: '数据中心', link: ''},
|
{icon: 'icon-park:data-lock', text: '数据中心', link: ''},
|
||||||
{icon: '/control.svg', text: '项导运维控制中台', link: ''},
|
{icon: '/icon/control.svg', text: '项导运维控制中台', link: ''},
|
||||||
{icon: '/vpn.svg', text: 'VPN服务', link: ''},
|
{icon: '/icon/vpn.svg', text: 'VPN服务', link: ''},
|
||||||
{icon: '/cloud.svg', text: '云计算资源调度中心', link: ''},
|
{icon: '/icon/cloud.svg', text: '云计算资源调度中心', link: ''},
|
||||||
{icon: '/maintain.svg', text: '服务器维护', link: '/backend-manage/server-maintainance/'},
|
{icon: '/icon/maintain.svg', text: '服务器维护', link: '/backend-manage/server-maintainance/'},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
icon: '/link.svg',
|
icon: '/icon/link.svg',
|
||||||
text: '友情链接',
|
text: '友情链接',
|
||||||
items: [
|
items: [
|
||||||
{icon: '/friend.svg', text: '个人', link: '/friends/persons/'},
|
{icon: '/icon/friend.svg', text: '个人', link: '/friends/persons/'},
|
||||||
{icon: '/organ.svg', text: '组织', link: '/friends/organizations/'},
|
{icon: '/icon/organ.svg', text: '组织', link: '/friends/organizations/'},
|
||||||
{icon: 'fa-solid:quote-left', text: 'Q&A', link: '/friends/quotes/'},
|
{icon: 'fa-solid:quote-left', text: 'Q&A', link: '/friends/quotes/'},
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
Before Width: | Height: | Size: 888 B After Width: | Height: | Size: 888 B |
Before Width: | Height: | Size: 965 B After Width: | Height: | Size: 965 B |
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 2.4 KiB After Width: | Height: | Size: 2.4 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 691 B After Width: | Height: | Size: 691 B |
Before Width: | Height: | Size: 6.2 KiB After Width: | Height: | Size: 6.2 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 2.6 KiB After Width: | Height: | Size: 2.6 KiB |
Before Width: | Height: | Size: 8.8 KiB After Width: | Height: | Size: 8.8 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
Before Width: | Height: | Size: 276 KiB After Width: | Height: | Size: 276 KiB |
Before Width: | Height: | Size: 1017 B After Width: | Height: | Size: 1017 B |
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 663 B After Width: | Height: | Size: 663 B |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 3.4 KiB After Width: | Height: | Size: 3.4 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 835 B After Width: | Height: | Size: 835 B |
Before Width: | Height: | Size: 391 KiB After Width: | Height: | Size: 391 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 3.7 KiB After Width: | Height: | Size: 3.7 KiB |
Before Width: | Height: | Size: 849 B After Width: | Height: | Size: 849 B |
Before Width: | Height: | Size: 6.0 KiB After Width: | Height: | Size: 6.0 KiB |
Before Width: | Height: | Size: 405 KiB After Width: | Height: | Size: 405 KiB |
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.2 KiB |
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 5.0 KiB |
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 3.8 KiB |
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
Before Width: | Height: | Size: 4.6 KiB After Width: | Height: | Size: 4.6 KiB |
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.6 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 2.7 KiB After Width: | Height: | Size: 2.7 KiB |
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 135 KiB After Width: | Height: | Size: 135 KiB |
Before Width: | Height: | Size: 2.0 KiB After Width: | Height: | Size: 2.0 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
@ -5,34 +5,34 @@ permalink: /contribute/
|
|||||||
---
|
---
|
||||||
|
|
||||||
首先感谢您的无私奉献,项导文档基于Vuepress的[plume主题构建](https://theme-plume.vuejs.press/)
|
首先感谢您的无私奉献,项导文档基于Vuepress的[plume主题构建](https://theme-plume.vuejs.press/)
|
||||||
,由多名成员共同维护,内容完全开源免费,并且承诺保障时效性和准确性。
|
,由多名成员共同维护,内容完全开源。
|
||||||
|
|
||||||
<RepoCard repo="MultipledMe/PGuide-Docs"></RepoCard>
|
<RepoCard repo="MultipledMe/PGuide-Docs"></RepoCard>
|
||||||
|
|
||||||
在参与合作开发之前,需要您学习一些基础知识:
|
|
||||||
|
|
||||||
## 我是文档的编写者
|
## 我是文档的编写者
|
||||||
|
|
||||||
- [markdown基础语法](/csdiy/tools-must/markdown/)
|
项导文档使用markdown语法进行编写,首先得大概掌握下[markdown基础语法](/csdiy/tools-must/markdown/)
|
||||||
|
|
||||||
在您完成markdown类型文档编写后可以
|
在您完成markdown类型文档编写后可以
|
||||||
- 通过github创建合并请求
|
- 通过github创建合并请求
|
||||||
- 直接发送到[我们的邮箱](mailto:losmosga@foxmail.com)
|
- email到[我们的邮箱](mailto:losmosga@foxmail.com)
|
||||||
|
- QQ发送给 [rand777](https://qm.qq.com/cgi-bin/qm/qr?k=9s5V15fEzwzHuawmc-QQZ615NPTp9oEZ)
|
||||||
|
|
||||||
### 我想直接写一篇文档
|
### 我想直接写一篇文档
|
||||||
|
|
||||||
不想这样麻烦也可以的,联系[rand777](https://qm.qq.com/q/2iLBaNcsnO)并获取语雀编辑权限,或将word文档发送给[rand777](https://qm.qq.com/q/2iLBaNcsnO)。
|
不想这样麻烦也可以的,联系[rand777](https://qm.qq.com/q/2iLBaNcsnO)并获取语雀编辑权限,或将word文档/PDF文档/PPT发送给[rand777](https://qm.qq.com/q/2iLBaNcsnO)
|
||||||
|
|
||||||
### 其他注意事项
|
### 其他注意事项
|
||||||
|
|
||||||
请参考`文档编写规范`
|
请参考`文档编写规范`
|
||||||
|
|
||||||
## 我是文档站的开发者
|
## 我是文档站的开发者
|
||||||
|
在参与合作开发之前,需要您学习一些基础知识:
|
||||||
|
|
||||||
- [git的使用](/csdiy/tools-must/git/)
|
- [:[material-icon-theme:git]:git的使用](/csdiy/tools-must/git/)
|
||||||
- [VuePress Plume主题](https://theme-plume.vuejs.press/guide/intro/)
|
- [:[https://theme-plume.vuejs.press/plume.png]:VuePress Plume主题](https://theme-plume.vuejs.press/guide/intro/)
|
||||||
- [Typescript基础语法](https://www.runoob.com/typescript/ts-basic-syntax.html)
|
- [:[devicon:typescript]:Typescript基础语法](https://www.runoob.com/typescript/ts-basic-syntax.html)
|
||||||
- [markdown基础语法](/csdiy/tools-must/markdown/)
|
- [:[octicon:markdown-16]:markdown基础语法](/csdiy/tools-must/markdown/)
|
||||||
|
|
||||||
随后,联系 [rand777](mailto:losmosga@foxmail.com) 加入项导文档加入github开发组。
|
随后,联系 [rand777](mailto:losmosga@foxmail.com) 加入项导文档加入github开发组。
|
||||||
|
|
||||||
@ -78,7 +78,7 @@ NVM(全名:Node.js Version Manager)可以帮助我们更高效地管理不
|
|||||||
```shell
|
```shell
|
||||||
git clone https://github.com/MultipledMe/PGuide-Docs.git
|
git clone https://github.com/MultipledMe/PGuide-Docs.git
|
||||||
```
|
```
|
||||||
也可以使用SSH协议导入,需要[配置SSH](/csdiy/tools-must/git/#设置ssh密钥)
|
也可以使用SSH协议导入,需要[配置SSH](/csdiy/tools-must/git/#设置ssh密钥)和[github设置](/csdiy/tools-must/git/#github设置)
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone git@github.com:MultipledMe/PGuide-Docs.git
|
git clone git@github.com:MultipledMe/PGuide-Docs.git
|
||||||
@ -111,31 +111,65 @@ pnpm run docs:dev
|
|||||||
|
|
||||||
打开[http://localhost:8080](http://localhost:8080)即可访问本地的开发环境了。代码修改时,内容也会一起跟着改。
|
打开[http://localhost:8080](http://localhost:8080)即可访问本地的开发环境了。代码修改时,内容也会一起跟着改。
|
||||||
|
|
||||||
6. 阅读开发规范章
|
6. 项目设置
|
||||||
|
|
||||||
请合作开发者依次阅读`Git规范`、`静态资源管理规范`、`文档编写规范`、`其他注意事项`、`常见问题及解决方案`
|
将 .cache .temp .public 文件夹设置为排除
|
||||||
|
|
||||||
|
7. 阅读开发规范章
|
||||||
|
|
||||||
|
请合作开发者依次阅读 [`Git规范`](/contribute/#git规范)、`静态资源管理规范`、`文档编写规范`、`其他注意事项`、`常见问题及解决方案`
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## Git规范
|
||||||
|
|
||||||
|
项导文档开发Git规范采用 [:[logos:angular-icon]:Angular 规范](https://zj-git-guide.readthedocs.io/zh-cn/latest/message/Angular%E6%8F%90%E4%BA%A4%E4%BF%A1%E6%81%AF%E8%A7%84%E8%8C%83/)
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
### 合并请求
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
## 文档编写规范
|
## 文档编写规范
|
||||||
|
|
||||||
俗话说,无规矩,不成方圆。一个优秀的团队离不开统一的规范,项导文档开发也是如此。
|
俗话说,无规矩,不成方圆。一个优秀的团队离不开统一的规范,项导文档开发也是如此。
|
||||||
|
|
||||||
## 静态资源规范
|
## 静态资源管理规范
|
||||||
|
|
||||||
这里是为了规范您的图片引用方法,Plume Vuepress推荐你引用静态资源的方式如下:
|
这里是为了规范您的**图片、视频、PDF、矢量图**引用方法,Plume Vuepress推荐你引用静态资源的方式如下:
|
||||||
|
|
||||||
|
:::info 静态资源类型、大小规范
|
||||||
|
- 图片文件:70%分辨率jpg或png图片,放入 `PGuide-Docs/.docs/.vuepress/public/`
|
||||||
|
- 视频文件:.mp4文件,帧率16/24FPS
|
||||||
|
- PDF文件:请尽量精简,不需要的页面不上传
|
||||||
|
:::
|
||||||
|
|
||||||
|
|
||||||
|
### 截图工具设置
|
||||||
|
|
||||||
截图工具
|
::: steps
|
||||||
|
1. 下载pixpin
|
||||||
|
|
||||||
## 对象存储
|
前往
|
||||||
|
|
||||||
|
2.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### 对象存储
|
||||||
|
|
||||||
下载[pixpin](https://pixpin.cn/)
|
所有**PDF、.mp4视频**放在项导腾讯云对象存储上,如有此类文件,将其发送给 rand777,链接处留空,并留下以下格式的TODO
|
||||||
|
|
||||||
|
> 今天天气多么好呀,于是我打开了书
|
||||||
|
> 这里==需要PDF文件==
|
||||||
|
|
||||||
|
然后写上TODO: 需要{文件名.pdf},并`ctrl`+`/`注释,在代码里看起来是这样的:
|
||||||
|
|
||||||
|
```text
|
||||||
|
高数,即高等数学,比初等数学高一些。教材如下:
|
||||||
|
#TODO: 需要高等数学.pdf
|
||||||
|
```
|
||||||
---
|
---
|
||||||
|
|
||||||
## 项目结构
|
## 项目结构
|
||||||
@ -185,65 +219,11 @@ pnpm run docs:dev
|
|||||||
- README.md #中文项导文档介绍
|
- README.md #中文项导文档介绍
|
||||||
- README-en.md #英文项导文档介绍
|
- README-en.md #英文项导文档介绍
|
||||||
- …
|
- …
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🎬 快速启航指南
|
|
||||||
|
|
||||||
### 🏗️ 搭建脚手架
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# 零基础同学建议安装nvm
|
|
||||||
nvm install lts
|
|
||||||
|
|
||||||
# 选择镜像源(顺风车时间)
|
|
||||||
nvm node_mirror https://mirrors.cernet.edu.cn/nodejs-release/ # 校园专线
|
|
||||||
nvm node_mirror https://mirrors.aliyun.com/nodejs-release/ # 阿里云快车
|
|
||||||
|
|
||||||
# 装备新时代工具箱
|
|
||||||
npm install -g pnpm # 速度更快的npm替代品
|
|
||||||
pnpm i # 一键安装所有魔法原料
|
|
||||||
pnpm run docs:dev # 打开传送门进本地预览
|
|
||||||
```
|
|
||||||
|
|
||||||
### ✨ 热更新小技巧
|
|
||||||
|
|
||||||
修改导航栏配置后记得`Ctrl+C`重启服务,看到"VuePress dev server listening"才算开启新世界大门哦~
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🌉 开发分支规范
|
|
||||||
|
|
||||||
### 代码地铁乘坐指南
|
|
||||||
|
|
||||||
1. 在本地开设`dev/[你的名字]`新线路
|
|
||||||
2. 完成精彩修改后:(快捷操作指南)
|
|
||||||
- `Ctrl+Shift+K` 召唤提交魔法阵
|
|
||||||
-
|
|
||||||
推荐消息格式:(让代码会说话,代码规范为 [Angular Commit](https://zj-git-guide.readthedocs.io/zh-cn/latest/message/Angular%E6%8F%90%E4%BA%A4%E4%BF%A1%E6%81%AF%E8%A7%84%E8%8C%83/))
|
|
||||||
```
|
|
||||||
docs: README新增星空导航
|
|
||||||
fix: 修复404星际迷航问题
|
|
||||||
feat: 新增宇宙超链接模块
|
|
||||||
```
|
|
||||||
3. 前往[Github站台](https://github.com/xxxx)点击「New pull request」提交专属班列
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📍 避坑手册精选
|
|
||||||
|
|
||||||
### 资源位面法则
|
|
||||||
|
|
||||||
- 🎨 所有矢量图请存入`/public/*`,引用时直接`/AI.svg`即可
|
|
||||||
- 📹 视频资源统一放在`src/video`,播放代码示范:
|
|
||||||
-
|
|
||||||
```markdown
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🆘 常见问题及解决方案
|
## 🆘 常见问题及解决方案
|
||||||
|
|
||||||
### 遇到git推送异常?(SSL ERROR)
|
### 遇到git推送异常?(SSL ERROR)
|
||||||
|