From 84abdd2c74c1a3129d8b5f30efcd8858bae25390 Mon Sep 17 00:00:00 2001 From: ChenHongYu <3283654267@qq.com> Date: Sun, 2 Mar 2025 22:07:24 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E5=AD=A6=E4=B9=A0?= =?UTF-8?q?=E8=B7=AF=E7=BA=BF=E5=89=8D=E7=AB=AF=E5=BC=80=E5=8F=91=E3=80=81?= =?UTF-8?q?=E5=BF=85=E5=AD=A6=E5=B7=A5=E5=85=B7=E3=80=81=E7=BC=96=E7=A8=8B?= =?UTF-8?q?=E5=85=A5=E9=97=A8=E3=80=81=E5=BC=80=E5=8F=91=E8=A7=84=E8=8C=83?= =?UTF-8?q?=E6=96=87=E6=A1=A3=EF=BC=8C=E6=96=B0=E5=A2=9E=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?README=E6=96=87=E6=A1=A3=E6=B3=A8=E6=84=8F=E4=BA=8B=E9=A1=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 + .../CS-DIY/学习路线/前端开发/1.三件套.md | 8 +- docs/notes/CS-DIY/学习路线/前端开发/NVM.md | 45 +++++++ .../CS-DIY/学习路线/前端开发/pythonFlask.md | 8 ++ docs/notes/CS-DIY/开发规范/README.md | 6 + docs/notes/CS-DIY/开发规范/什么是开发规范.md | 72 +++++++++++ .../CS-DIY/开发规范/阿里系开发规范/Java.md | 8 ++ .../CS-DIY/开发规范/阿里系开发规范/README.md | 6 + docs/notes/CS-DIY/必学工具/Git.md | 116 ++++++++++++++++++ docs/notes/CS-DIY/必学工具/README.md | 6 + docs/notes/CS-DIY/编程入门/python.md | 1 - 11 files changed, 276 insertions(+), 2 deletions(-) create mode 100644 docs/notes/CS-DIY/学习路线/前端开发/NVM.md create mode 100644 docs/notes/CS-DIY/学习路线/前端开发/pythonFlask.md create mode 100644 docs/notes/CS-DIY/开发规范/README.md create mode 100644 docs/notes/CS-DIY/开发规范/什么是开发规范.md create mode 100644 docs/notes/CS-DIY/开发规范/阿里系开发规范/Java.md create mode 100644 docs/notes/CS-DIY/开发规范/阿里系开发规范/README.md create mode 100644 docs/notes/CS-DIY/必学工具/Git.md create mode 100644 docs/notes/CS-DIY/必学工具/README.md diff --git a/README.md b/README.md index 0c18f14..edc1427 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,8 @@ - markdown文档隔行写 - 请将`public`文件夹设置为 **Excluded**：右键 -> mark as -> excluded folder - 否则svg等静态文件的命名空间等信息会报错。 +- 永久链接 permalink 注意末尾不要缺少 " / " 表示请求路径 +- 修改头部导航栏的时候记得重启项目 ## Q&A - git进行push报错出现
diff --git a/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md b/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md index 91a649d..d533534 100644 --- a/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md +++ b/docs/notes/CS-DIY/学习路线/前端开发/1.三件套.md @@ -1,5 +1,11 @@ --- title: HTML CSS JS createTime: 2025/02/24 06:48:41 -permalink: /csdiy/full-stack-dev/html-css-js/ +permalink: /csdiy/study-path/front-dev/html-css-js/ +icon: icon-park-solid:bring-to-front --- + +前端的基础看pink老师的课程学习HTML和CSS以及JS基础即可 + +@[bilibili](BV14J4114768) + diff --git a/docs/notes/CS-DIY/学习路线/前端开发/NVM.md b/docs/notes/CS-DIY/学习路线/前端开发/NVM.md new file mode 100644 index 0000000..06c7d9d --- /dev/null +++ b/docs/notes/CS-DIY/学习路线/前端开发/NVM.md @@ -0,0 +1,45 @@ +--- +title: NVM +createTime: 2025/03/02 17:16:56 +permalink: /csdiy/study-path/front-dev/NVM/ +icon: simple-icons:nvm +--- + +Node Version Manager，不同的前端项目往往需要不同的 node.js 版本，它可以帮我快速切换版本 + +# Windows +## 安装 +前往 [nvm for windows(github)](https://github.com/coreybutler/nvm-windows)
+你看到的版本号可能不一样，因为 nvm 一直在更新! + +根据如下步骤进行操作 +![img_3.png](..%2F..%2F..%2F..%2F.vuepress%2Fpublic%2Fsrc%2Fimg_3.png) +![img_2.png](..%2F..%2F..%2F..%2F.vuepress%2Fpublic%2Fsrc%2Fimg_2.png) + +下载完成后安装，一直下一步即可 + +## 验证安装 +![img_4.png](..%2F..%2F..%2F..%2F.vuepress%2Fpublic%2Fsrc%2Fimg_4.png) + +## npm安装与使用 +淘宝镜像用于加速 npm 包下载速度 +::: code-tabs + +@tab 配置npm淘宝镜像源 +```shell +npm config set registry https://registry.npmmirror.com +``` + +@tab 安装LTS长期支持版本 +```shell +nvm install lts +``` + +@tab 使用npm +```shell +nvm use lts +``` + +::: + +出现 now use node[ 版本号 ] 即可 \ No newline at end of file diff --git a/docs/notes/CS-DIY/学习路线/前端开发/pythonFlask.md b/docs/notes/CS-DIY/学习路线/前端开发/pythonFlask.md new file mode 100644 index 0000000..5020455 --- /dev/null +++ b/docs/notes/CS-DIY/学习路线/前端开发/pythonFlask.md @@ -0,0 +1,8 @@ +--- +title: pythonFlask +createTime: 2025/03/02 20:20:50 +permalink: /csdiy/study-path/front-dev/pythonflask/ +icon: logos:flask +--- + +[JetBrains Flask入门教程](https://www.jetbrains.com/help/pycharm/2024.3/creating-web-application-with-flask.html) diff --git a/docs/notes/CS-DIY/开发规范/README.md b/docs/notes/CS-DIY/开发规范/README.md new file mode 100644 index 0000000..fbb27db --- /dev/null +++ b/docs/notes/CS-DIY/开发规范/README.md @@ -0,0 +1,6 @@ +--- +title: 开发规范 +createTime: 2025/03/02 20:23:57 +permalink: /csdiy/dev-rules/ +icon: '/dev-standard.svg' +--- diff --git a/docs/notes/CS-DIY/开发规范/什么是开发规范.md b/docs/notes/CS-DIY/开发规范/什么是开发规范.md new file mode 100644 index 0000000..1a07e7f --- /dev/null +++ b/docs/notes/CS-DIY/开发规范/什么是开发规范.md @@ -0,0 +1,72 @@ +--- +title: 什么是开发规范 +createTime: 2025/03/02 20:31:41 +permalink: /csdiy/dev-rules/what-dev-rules/ +icon: ic:baseline-rule-folder +--- +# 什么是开发规范？ +无规矩不成方圆，一个优秀的开发团队，必定离不开团队齐心协力规范的制定。 + +**为什么说它是最重要的？因为：开发不规范，同事两行泪！** + +开发规范是每位软件开发者在团队开发中必须遵守的，比如项目代码统一缩进两格、项目圈复杂度不能超过 10 等等。遵守规范有利于提高项目的开发效率、降低维护成本；而如果你不遵守规范，可能会影响到整个团队的开发进度，别人也不乐意和你合作。 + +## 学习建议 +开发规范的学习分为 3 个阶段： + +1. 了解开发规范，有人工遵守规范的意识 +2. 学会使用工具来帮助自己遵守代码规范，防止人工的疏忽 +3. 学会为团队项目定制规范 + +由于每个团队遵循的开发规范不完全相同，所以千万不要死记硬背规范！ + +建议大家先简单过一遍大厂团队的代码规范手册（相对标准通用一些），以后做项目的时候只要想到了某个规范，就赶紧去查阅文档确认下。当然也可以直接利用开发工具自带的一些代码检查插件，帮你去纠正一些没注意到的问题。 + +这里建议大家在前期开发项目时，多观察一些编辑器自动给出的 warning 提示，并且尝试把警告消除。 + +项目做得多了、慢慢养成习惯后，你会发现遵循规范是一件 “水到渠成” 的事情，不用刻意去记。 + +而当你成为团队的负责人后，在大家动手做项目前，必须先制定一套开发规范，全场动作才能整齐划一！ + +## 知识 +- 了解开发规范 + - 编码规范 + - 代码风格 + - 变量命名 + - 代码格式 + - 设计规范 + - 开发原则 + - 设计原则 + - 文档规范 + - 文档结构 + - 文档格式 + - 文档内容 +- 代码校验工具 + - 通用: Sonar + - Python: pylint + - 前端: ESLint + - C++: clang-tidy + - Java: CheckStyle +- 制定代码规范 + +## 资源 +- 书籍 + - [《软件工程:实践者的研究方法》](https://book.douban.com/subject/6047742/)（经典大黑书，讲的非常全面，但同样完整读下来还是有些难度的） + + [PDF 软件工程:实践者的研究方法(第7版)](https://github.com/QSCTech/zju-icicles/blob/master/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B/%E6%95%99%E6%9D%90/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B%EF%BC%9A%E5%AE%9E%E8%B7%B5%E8%80%85%E7%9A%84%E7%A0%94%E7%A9%B6%E6%96%B9%E6%B3%95%EF%BC%88%E7%AC%AC7%E7%89%88%EF%BC%89.pdf) + - [《软件开发的201个原则》](https://book.douban.com/subject/35628886/)（工具书，看一遍挺好的） + - [**阿里巴巴Java开发手册**](https://developer.aliyun.com/graph/java)（搜索《Java开发手册》） + - [**Airbnb JavaScript代码规范**](https://github.com/BingKui/javascript-zh) +- 视频 + - 北京大学软件工程 + @[bilibili](BV1Vt411V72G) + - 大连工业大学软件工程 + @[bilibili](BV1Ns41177VM) + - [华山版《Java开发手册》独家讲解](https://developer.aliyun.com/live/1201) +- 大学课件 + - [浙大计算机软件工程](https://github.com/QSCTech/zju-icicles) +- 文档 + - [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)（谷歌 Java 代码规范） + +## **尾语** +**我们要养成开发规范的好习惯这样我们才能输出更加优质的代码~** \ No newline at end of file diff --git a/docs/notes/CS-DIY/开发规范/阿里系开发规范/Java.md b/docs/notes/CS-DIY/开发规范/阿里系开发规范/Java.md new file mode 100644 index 0000000..6590d9a --- /dev/null +++ b/docs/notes/CS-DIY/开发规范/阿里系开发规范/Java.md @@ -0,0 +1,8 @@ +--- +title: Java +createTime: 2025/03/02 21:05:29 +permalink: /csdiy/dev-rules/alibaba-rules/java-rule/ +--- + +# Java开发规范 +[Alibaba Java 技术图谱，助力成神之路](https://developer.aliyun.com/graph/java) \ No newline at end of file diff --git a/docs/notes/CS-DIY/开发规范/阿里系开发规范/README.md b/docs/notes/CS-DIY/开发规范/阿里系开发规范/README.md new file mode 100644 index 0000000..7aae08b --- /dev/null +++ b/docs/notes/CS-DIY/开发规范/阿里系开发规范/README.md @@ -0,0 +1,6 @@ +--- +title: 阿里系开发规范 +createTime: 2025/03/02 21:04:02 +permalink: /csdiy/dev-rules/alibaba-rules/ +icon: ri:alibaba-cloud-fill +--- diff --git a/docs/notes/CS-DIY/必学工具/Git.md b/docs/notes/CS-DIY/必学工具/Git.md new file mode 100644 index 0000000..adc4724 --- /dev/null +++ b/docs/notes/CS-DIY/必学工具/Git.md @@ -0,0 +1,116 @@ +--- +title: Git +createTime: 2025/03/02 21:14:04 +permalink: /csdiy/tools-must/git/ +icon: skill-icons:git +--- + +# Git +## 为什么使用Git +### 典型的使用场景 +- 你在学校电脑上写好了代码，但是不想关机就丢失了，这时可以上传到代码管理仓库，下次清空电脑后只需要从你的仓库拉取代码即可，不用背电脑咯。 +- 你有好几台电脑，不想带着笨重的游戏本到处跑，可以只带一个轻薄本出门，拉取其他设备上写好的代码即可。 +- 你有一个团队，需要合作完成一个项目，在你所在的分支工作，提交 PR 即可。 + +Git 是一款分布式的代码版本控制工具，Linux 之父 Linus 嫌弃当时主流的中心式的版本控制工具太难用还要花钱，就自己开发出了 Git 用来维护 Linux 的版本（给大佬跪了）。 + +Git 的设计非常优雅，但初学者通常因为很难理解其内部逻辑因此会觉得非常难用。对 Git 不熟悉的初学者很容易出现因为误用命令将代码给控制版本控制没了的状况（好吧是我）。 + +但相信我，和 Vim 一样，Git 是一款你最终掌握之后会感叹“它值得！”的神器。 + +## 如何学习Git +[先试试这个可视化小游戏](https://learngitbranching.js.org/?locale=zh_CN) + +不建议初学者在一知半解的情况下贸然使用 Git，因为它的内部逻辑并不能熟能生巧，而是需要花时间去理解。我推荐的学习路线如下： +:::steps +1. 阅读这篇 [Git tutorial](https://missing.csail.mit.edu/2020/version-control/)，视频的话可以看这个尚硅谷Git教程 + +2. 阅读这本开源书籍 [Pro Git](https://git-scm.com/book/en/v2) 的 Chapter1 - Chapter5，是的没错，学 Git 需要读一本书（捂脸）。 + +3. 此时你已经掌握了 Git 的原理和绝大部分用法，接下来就可以在实践中反复巩固 Git 的命令了。但用好它同样是一门哲学，我个人觉得这篇如何写好 [Commit Message](https://cbea.ms/git-commit/) 的博客非常值得一读。 + +4. 好的此时你已经爱上了 Git，你已经不满足于学会它了，你想自己实现一个 Git！巧了，我当年也有这样的想法，这篇 [tutorial](https://wyag.thb.lt/) 可以满足你！ + +5. 什么？光实现一个 Git 无法满足你？小伙子/小仙女有前途，巧的是我也喜欢造轮子，这两个 GitHub 项目 [build-your-own-x](https://github.com/codecrafters-io/build-your-own-x) 和 [project-based-learning](https://github.com/practical-tutorials/project-based-learning) 收录了你能想到的各种造轮子教程，比如：自己造个编辑器、自己写个虚拟机、自己写个 docker、自己写个 TCP 等等等等。 + +::: +[关于版本控制 - Git Guide](https://zj-git-guide.readthedocs.io/zh-cn/latest/get-started/%E5%85%B3%E4%BA%8E%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6/) + +:::tip + +此处待写Git IDE集成 / 申请教育版 + +[//]: # (TODO: 此处待写Git IDE集成 / 申请教育版) + +::: +## 软件集成 +通过设置，git 可以在各 IDE 中进行集成，无需使用 git-bash 命令行工具，你可能需要知道XXX 如何 XXX + +## 设置SSH密钥 +第一次需要生成 SSH 密钥对，可以按照以下步骤在你的终端或命令提示符中执行相应的命令： + +:::steps +1. **打开终端**（在 Linux 或 macOS 上）或 **命令提示符/PowerShell**（在 Windows 上）。 +2. **输入以下命令**（以生成 RSA 类型的密钥）： +```shell +ssh-keygen -t rsa -b 4096 -C "your_email@example.com" +``` +其中 -t rsa 指定密钥类型为 RSA，-b 4096 指定密钥长度为 4096 位，-C 是可选的注释字段，通常你可以用自己的电子邮件地址来标识这个密钥。 + +3. **按回车键(一路回车)**，它会提示你输入保存密钥的文件路径。默认情况下，密钥会保存在 `~/.ssh/id_rsa`（Linux 和 macOS）或 `C:\Users\\.ssh\id_rsa`（Windows）中。如果你想使用默认位置，可以直接按回车键。 + +4. **接下来，它会提示你输入一个密码短语。** 你可以选择输入一个密码短语以增加安全性，或者直接按回车键不使用密码短语。 + +5. **生成完成后，你会看到类似下面的输出:** ![2025-03-02_21-34-53.png](/src/2025-03-02_21-34-53.png) + +6. **查看公钥和私钥** 你可以使用以下命令查看公钥内容（确保不要共享私钥）： + +```shell +cat ~/.ssh/id_rsa.pub +``` + +私钥:`~/.ssh/id_rsa` + +公钥:`~/.ssh/id_rsa.pub` + +7. **将公钥添加到服务器:** 如果你要将生成的公钥添加到远程服务器上，通常需要将 `id_rsa.pub` 的内容添加到该服务器的 `~/.ssh/authorized_keys` 文件中。 + +::: + +## 查看SSH公钥 +安装 git 后，在桌面右键 + +![2025-03-02_21-43-02.png](/src/2025-03-02_21-43-02.png) + +![2025-03-02_21-44-08.png](/src/2025-03-02_21-44-08.png) + +![2025-03-02_21-44-52.png](/src/2025-03-02_21-44-52.png) + +## Github设置 +进入个人 github 主页，点击设置： + +![2025-03-02_21-46-06.png](/src/2025-03-02_21-46-06.png) + +![2025-03-02_21-47-18.png](/src/2025-03-02_21-47-18.png) + +Title可以填写设备名，比如笔记本 + +Key Type不变 + +Key把刚刚复制的粘贴进去 + +## 测试 +win + r 输入并打开cmd +:::code-tabs +@tab SSH克隆仓库 + +```shell +git clone git@github.com:kvcache-ai/ktransformers.git +``` + +::: + +显示 +![2025-03-02_21-52-46.png](/src/2025-03-02_21-52-46.png) + +即为成功设置 \ No newline at end of file diff --git a/docs/notes/CS-DIY/必学工具/README.md b/docs/notes/CS-DIY/必学工具/README.md new file mode 100644 index 0000000..99a7952 --- /dev/null +++ b/docs/notes/CS-DIY/必学工具/README.md @@ -0,0 +1,6 @@ +--- +title: 必学工具 +createTime: 2025/03/02 21:07:55 +permalink: /csdiy/tools-must/ +icon: mdi:tools +--- diff --git a/docs/notes/CS-DIY/编程入门/python.md b/docs/notes/CS-DIY/编程入门/python.md index 89fd44c..ab503e5 100644 --- a/docs/notes/CS-DIY/编程入门/python.md +++ b/docs/notes/CS-DIY/编程入门/python.md @@ -5,7 +5,6 @@ permalink: /csdiy/program-begin/python/ icon: devicon:python --- -[//]: # (TODO:chy待填写) ## 学习路线