From ac183a6f5e879e75fcbdc51f35e7f69dae8fc65d Mon Sep 17 00:00:00 2001 From: rand777 Date: Tue, 4 Mar 2025 00:15:44 +0800 Subject: [PATCH] docs: nvm lobechat contribute markdown. project --- docs/.vuepress/navbar.ts | 3 +- .../CS-DIY/学习路线/前端开发/1.三件套.md | 1 + docs/notes/CS-DIY/学习路线/前端开发/NVM.md | 10 +-- docs/notes/contribute.md | 65 +++++++++++-------- .../notes/公共服务/生成式人工智能/LobeChat.md | 1 + docs/notes/项目文档/CQMUA服务器中心/README.md | 6 ++ docs/notes/项目文档/像素大学城/README.md | 6 ++ .../项目文档/全国大学生竞赛组队系统/README.md | 5 ++ 8 files changed, 63 insertions(+), 34 deletions(-) create mode 100644 docs/notes/项目文档/CQMUA服务器中心/README.md create mode 100644 docs/notes/项目文档/像素大学城/README.md create mode 100644 docs/notes/项目文档/全国大学生竞赛组队系统/README.md diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts index d662b90..9dadcdc 100644 --- a/docs/.vuepress/navbar.ts +++ b/docs/.vuepress/navbar.ts @@ -21,10 +21,9 @@ export const navbar = defineNavbarConfig([ {icon: '/zhiyu.png', text: '植愈:AI情绪小帮手', link: ''}, {icon: '/robot.png', text: '智慧中草药生态养护平台', link: ''}, {icon: '/univ-town.svg', text: '像素大学城', link: ''}, - {icon: '/command_block.gif', text: 'CQMUA服务器中心', link: ''}, + {icon: '/command_block.gif', text: 'CQMUA服务器中心', link: '/notes/项目文档/CQMUA服务器中心/README.md'}, {icon: '/analyse.svg',text: '学情分析系统',link: ''}, {icon: '/zzfy.svg',text: '掌中方圆',link: ''}, - {icon: '/internship.svg',text: '网络实习就业信息网',link:''} ] }, { diff --git a/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md b/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md index d533534..9e4395f 100644 --- a/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md +++ b/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md @@ -9,3 +9,4 @@ icon: icon-park-solid:bring-to-front @[bilibili](BV14J4114768) +@[bilibili](BV1Y84y1L7Nn) \ No newline at end of file diff --git a/docs/notes/CS-DIY/学习路线/前端开发/NVM.md b/docs/notes/CS-DIY/学习路线/前端开发/NVM.md index 06c7d9d..aad6ffd 100644 --- a/docs/notes/CS-DIY/学习路线/前端开发/NVM.md +++ b/docs/notes/CS-DIY/学习路线/前端开发/NVM.md @@ -7,9 +7,9 @@ icon: simple-icons:nvm Node Version Manager,不同的前端项目往往需要不同的 node.js 版本,它可以帮我快速切换版本 -# Windows -## 安装 -前往 [nvm for windows(github)](https://github.com/coreybutler/nvm-windows)
+## Windows +### 安装 +前往 :[line-md:github-twotone]: [nvm for windows](https://github.com/coreybutler/nvm-windows)
你看到的版本号可能不一样,因为 nvm 一直在更新! 根据如下步骤进行操作 @@ -18,10 +18,10 @@ Node Version Manager,不同的前端项目往往需要不同的 node.js 版本 下载完成后安装,一直下一步即可 -## 验证安装 +### 验证安装 ![img_4.png](..%2F..%2F..%2F..%2F.vuepress%2Fpublic%2Fsrc%2Fimg_4.png) -## npm安装与使用 +### npm安装与使用 淘宝镜像用于加速 npm 包下载速度 ::: code-tabs diff --git a/docs/notes/contribute.md b/docs/notes/contribute.md index d2305d2..428a961 100644 --- a/docs/notes/contribute.md +++ b/docs/notes/contribute.md @@ -8,50 +8,61 @@ permalink: /contribute/ -在参与合作开发之前,您首先得学习一些基础知识: +在参与合作开发之前,需要您学习一些基础知识: ## 我是文档站的开发者 -- git的使用 -- vuepress plume主题 -- typescript +- [git的使用](/csdiy/tools-must/git/) +- [VuePress Plume主题](https://theme-plume.vuejs.press/guide/intro/) +- [Typescript基础语法](https://www.runoob.com/typescript/ts-basic-syntax.html) +- markdown基础语法 ## 我是文档的编写者 - markdown基础语法 -- vuepress md拓展语法 -- 合并请求的创建 +- VuePress markdown拓展语法 +- 合并请求的创建(也可以联系文档管理员) -### markdown支持 -目前,文档支持所有markdown基础语法 +### 我想直接写一篇文档 + +也可以的,联系[rand777](https://qm.qq.com/q/2iLBaNcsnO)并获取语雀编辑权限 ### 项目克隆 -确保团队成员使用 SSH 或 HTTPS 统一方式克隆仓库: +团队使用 SSH 或 HTTPS 统一方式克隆:[line-md:github-loop]:仓库: + ```bash -git clone https://zds.cqmu.edu.cn/pguide-studio/pguide-docs -cd PGuide-Docs -pnpm install # 安装依赖 +git clone https://github.com/MultipledMe/PGuide-Docs ``` -这一步可以参考 [README.md](../../README.md) +这一步可以参考 [README.md](https://github.com/MultipledMe/PGuide-Docs/blob/master/README.md) --- ## 项目结构 -```bash -docs/ - .vuepress/ - config.js # VuePress 主配置 - plume-theme/ # Plume 主题配置 - components/ # 自定义组件 - styles/ # 覆盖主题样式 - public/ # 静态资源(图片、字体等) - README.md # 文档首页 - 其他目录/ # 业务文档(按需组织) -pnpm-lock.yaml -package.json -``` +::: file-tree + +- docs + - .vuepress + - config.ts + - page1.md + - README.md +- theme 一个 **主题** 目录 + - client + - components + - **Navbar.vue** + - composables + - useNavbar.ts + - styles + - navbar.css + - config.ts + - node/ +- package.json +- pnpm-lock.yaml +- .gitignore +- README.md +- … + ::: --- @@ -64,12 +75,12 @@ pnpm docs:dev # 运行后访问 http://localhost:8080 ### 编写文档 - **新增页面**:在 `docs/` 下创建 `.md` 文件,按约定式路由生成路径。 -- **配置侧边栏**:在 `.vuepress/config.js` 的 `themeConfig.sidebar` 中添加导航。 - **遵循Frontmatter**: ```markdown --- title: 示例页面 editLink: false + permalink: /../../ --- ``` diff --git a/docs/notes/公共服务/生成式人工智能/LobeChat.md b/docs/notes/公共服务/生成式人工智能/LobeChat.md index 4e6dbb7..ce32663 100644 --- a/docs/notes/公共服务/生成式人工智能/LobeChat.md +++ b/docs/notes/公共服务/生成式人工智能/LobeChat.md @@ -31,4 +31,5 @@ fullscreen 1. [ ] 接入统一认证中心 2. [ ] 展示各组织使用量 3. [ ] EChart.js展示日均使用分布 +4. [ ] 使用数据库版本 diff --git a/docs/notes/项目文档/CQMUA服务器中心/README.md b/docs/notes/项目文档/CQMUA服务器中心/README.md new file mode 100644 index 0000000..8e43edf --- /dev/null +++ b/docs/notes/项目文档/CQMUA服务器中心/README.md @@ -0,0 +1,6 @@ +--- +title: CQMUA服务器中心 +createTime: 2025/03/04 00:02:13 +permalink: /project-docs/cqmua-center/intro/ +icon: '/command_block.gif' +--- diff --git a/docs/notes/项目文档/像素大学城/README.md b/docs/notes/项目文档/像素大学城/README.md new file mode 100644 index 0000000..2bfdde4 --- /dev/null +++ b/docs/notes/项目文档/像素大学城/README.md @@ -0,0 +1,6 @@ +--- +title: README +createTime: 2025/03/04 00:06:49 +permalink: /project-docs/pixel-university-town/ +icon: '/univ-town.svg' +--- diff --git a/docs/notes/项目文档/全国大学生竞赛组队系统/README.md b/docs/notes/项目文档/全国大学生竞赛组队系统/README.md new file mode 100644 index 0000000..d45bce5 --- /dev/null +++ b/docs/notes/项目文档/全国大学生竞赛组队系统/README.md @@ -0,0 +1,5 @@ +--- +title: README +createTime: 2025/03/04 00:08:05 +permalink: /project-docs/4uek2j5p/ +---