Skip to content

Commit 662983c

Browse files
Phil-Fanclaude
andcommitted
docs: 扩展文档内容并优化资源结构
- 新增多个社区平台资源链接 (X、小红书、即刻、Folo) - 扩充 Linux 文档内容 (数据处理、用户管理、系统管理) - 更新 CI/CD 部分,重新组织 commit hooks 分类 - 添加 pretier 镜像源用于 pre-commit - 新增 clean 脚本命令 Co-Authored-By: Claude <noreply@anthropic.com>
1 parent deb4efb commit 662983c

32 files changed

Lines changed: 3470 additions & 2423 deletions

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@
1111
- [Linux.do](https://linux.do/)
1212
- [Hacker News](https://news.ycombinator.com/)
1313
- [OSPP](https://summer-ospp.ac.cn)
14+
- [X](https://x.com/)
15+
- [小红书](https://www.xiaohongshu.com/)
1416
- [小宇宙](https://www.xiaoyuzhoufm.com/)
17+
- [即刻](https://web.okjike.com)
18+
- [Folo](https://github.com/RSSNext/Folo): All-in-one RSS reader.
1519

1620
## AI 相关
1721

@@ -72,9 +76,13 @@ brew install gemini-cli
7276
提问语句:
7377

7478
```text
75-
read this @SPEC.md and interview me in detail using the AskUserQuestionTool about literally anything: technical implementation, UI & UX, concerns, tradeoffs, etc. but make sure the questions are not obvious
79+
read this @SPEC.md and interview me in detail
80+
using the AskUserQuestionTool about literally anything:
81+
technical implementation, UI & UX, concerns, tradeoffs, etc.
82+
but make sure the questions are not obvious
7683
77-
be very in-depth and continue interviewing me continually until it's complete, then write the spec to the file
84+
be very in-depth and continue interviewing me continually
85+
until it's complete, then write the spec to the file.
7886
```
7987

8088
### Skills
@@ -194,11 +202,15 @@ npx create-next-app@latest my-app
194202
- [jenkins](https://www.jenkins.io)
195203
- [Dagger](https://dagger.io/):可编排的 CI/CD 引擎
196204
- [Drone CI](https://github.com/harness/drone)
197-
- [pre-commit](https://github.com/pre-commit/pre-commit):多语言 pre-commit hooks 管理框架
205+
206+
- commit hooks:
207+
- [pre-commit](https://github.com/pre-commit/pre-commit):多语言 pre-commit hooks 管理框架
208+
- [husky](https://github.com/typicode/husky) 适合前端项目
198209

199210
- Linter:
200211
- [eslint/eslint](https://github.com/eslint/eslint): JavaScript/TypeScript 静态分析
201212
- [prettier/prettier](https://github.com/prettier/prettier): 代码格式化
213+
- [rbubley/mirrors-prettier](https://github.com/rbubley/mirrors-prettier) for pre-commit
202214
- [biomejs/biome](https://github.com/biomejs/biome): 一体化 Linter & Formatter & Bundler(ESLint + Prettier 替代)
203215
- [markdownlint](https://github.com/DavidAnson/markdownlint): Markdown 静态分析
204216
- [autocorrect](https://github.com/huacnlee/autocorrect): CJK 排版自动修正

docs/AI/MCP.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ MCP 并不是最早出现的类似事物,之前就有很多类似的尝试,
1414
- longchain:抽象层数太多,想要囊括的太多
1515
- pydantic:使用 python 抽象器进行抽象
1616

17-
!!! note "把时间花在解决问题上面,而不是 build server"
17+
:::tip 把时间花在解决问题上面,而不是 build server
18+
:::
19+
1820
mcp 作为 distribute 一个好的方式
1921

2022
当我们使用一个工具的时候,我们不仅仅是在使用这个工具,更是接受这个工具对于未来的设想与设计

docs/Backend/db/sql.md

Lines changed: 273 additions & 251 deletions
Large diffs are not rendered by default.

docs/Backend/php.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,15 @@
55
66
[PHP 学习路线](https://www.runoob.com/w3cnote/php-learning-recommend.html)
77

8-
!!! tip "学习路线" 1. 熟悉 HTML/CSS/JS 等网页基本元素,完成阶段可自行制作简单的网页,对元素属性相对熟悉。2. 理解动态语言的概念和运做机制,熟悉基本的 PHP 语法。3. 学习如何将 PHP 与 HTML 结合起来,完成简单的动态页面。4. 接触学习 MySQL,开始设计数据库。5. 不断巩固 PHP 语法,熟悉大部分的 PHP 常用函数,理解面向对象编程,MySQL 优化,以及一些模板和框架。6. 最终完成一个功能齐全的动态站点。
8+
:::tip 学习路线
9+
10+
:::
911

1012
## 基础语法
1113

12-
!!! note "优化之前写过的评论网页"
14+
:::tip 优化之前写过的评论网页
15+
16+
:::
1317

1418
- PHP 是一种开源的通用脚本语言,尤其适用于 Web 开发。
1519
- PHP(全称:PHP:Hypertext Preprocessor,即"PHP:超文本预处理器")是一种通用开源脚本语言。
@@ -233,7 +237,9 @@ $conn->close();
233237

234238
将序列化的值当作参数传入
235239

236-
!!! note "最终的原因"
240+
:::tip 最终的原因
241+
:::
242+
237243
PHP 是弱类型的原因,我们可以利用这样的特性去绕过一些判断
238244

239245
#### [BUUCTF[极客大挑战 2019]PHP](https://buuoj.cn/challenges#[%E6%9E%81%E5%AE%A2%E5%A4%A7%E6%8C%91%E6%88%98%202019]PHP)
@@ -303,7 +309,9 @@ O:4:"Name":2:{s:14:"Nameusername";s:5:"admin";s:14:"Namepassword";i:100;}
303309

304310
又因为私有变量需要修改,所以更改为
305311

306-
!!! note "在反序列化时,当前属性个数大于实际属性个数时,就会跳过`__wakeup()`,去执行`__destruct`"
312+
:::tip 在反序列化时,当前属性个数大于实际属性个数时,就会跳过`__wakeup()`,去执行`__destruct`
313+
314+
:::
307315

308316
又因为需要绕过`__wakeup()`函数,所以我们把属性个数改成大于实际属性的个数
309317

@@ -317,7 +325,9 @@ http://02801fc4-349c-428a-bb2c-2015f2934d2b.node5.buuoj.cn:81/?select=O:4:%22Nam
317325

318326
上课老师讲的一个例题,主要核心思想就是利用 php 这种弱类型的语言。构造的 exp 是利用引用,使得两个变量一模一样,从而达到目的。
319327

320-
!!! note "类型"
328+
:::tip 类型
329+
:::
330+
321331
a - array
322332
b - boolean
323333
d - double

docs/Backend/platform/xcode.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# IOS 开发
22

3-
!!! note "记录一下学习 IOS 开发的尝试"
3+
:::tip 记录一下学习 IOS 开发的尝试
4+
5+
:::
46

57
## 安装
68

docs/Backend/python.md

Lines changed: 47 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ pip index versions <package>
1414
pip install <package>==<version>
1515
```
1616

17-
!!! note "windows 使用命令行调用不同版本的 python"
17+
:::tip windows 使用命令行调用不同版本的 python
1818

19-
在系统路径path(高级系统系统设置——环境变量)中加入python.exe所在目录(打开文件所在位置——属性——打开文件所在位置)(因为是快捷方式,所以需要先找到快捷方式所在目录,再找到原exe文件所在位置
19+
在系统路径 path(高级系统系统设置——环境变量)中加入 python.exe 所在目录(打开文件所在位置——属性——打开文件所在位置)(因为是快捷方式,所以需要先找到快捷方式所在目录,再找到原 exe 文件所在位置
2020

21-
**注:应考虑到优先级的问题,将想要通过命令行直接进入的 python 版本所对应的路径放在上面**
21+
**注:应考虑到优先级的问题,将想要通过命令行直接进入的 python 版本所对应的路径放在上面**
22+
23+
:::
2224

2325
### pip 换源
2426

@@ -30,13 +32,16 @@ pip install package_name -i https://pypi.tuna.tsinghua.edu.cn/simple
3032
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
3133
```
3234

33-
!!! bug "WARNING: The repository located at mirrors.aliyun.com is not a trusted or secure host and is being ignored. If this repository is available via HTTPS we recommend you use HTTPS instead, otherwise you may silence this warning and allow it anyway with '--trusted-host mirrors.aliyun.com'."
34-
在大多数情况下,这个警告表示 pip 无法验证镜像源的 SSL 证书。可能的原因包括:
35+
:::warning
36+
WARNING: The repository located at mirrors.aliyun.com is not a trusted or secure host and is being ignored. If this repository is available via HTTPS we recommend you use HTTPS instead, otherwise you may silence this warning and allow it anyway with '--trusted-host mirrors.aliyun.com'.
37+
38+
这个警告表示 pip 无法验证镜像源的 SSL 证书。可能的原因包括:
3539

36-
SSL证书问题: 镜像源的SSL证书过期、自签名或存在其他问题。
37-
网络问题: 在某些网络环境中(特别是公司网络或学校网络),中间人攻击(MITM)防御机制可能会导致证书验证失败。
40+
- SSL 证书问题:镜像源的 SSL 证书过期、自签名或存在其他问题。
41+
- 网络问题:在某些网络环境中(特别是公司网络或学校网络),中间人攻击 (MITM) 防御机制可能会导致证书验证失败。
3842

39-
[已解决WARNING: The repository located at mirrors.aliyun.com is not a trusted or secure host异常的正确解决方法,亲测\_the repository located at mirrors, aliyun, com is -CSDN博客](https://blog.csdn.net/FMC_WBL/article/details/136143632)
43+
[已解决 WARNING: The repository located at mirrors.aliyun.com is not a trusted or secure host 异常的正确解决方法,亲测\_the repository located at mirrors, aliyun, com is -CSDN 博客](https://blog.csdn.net/FMC_WBL/article/details/136143632)
44+
:::
4045

4146
### pip 导出环境
4247

@@ -133,7 +138,9 @@ uv venv --python 3.11
133138
export UV_DEFAULT_INDEX="https://mirrors.aliyun.com/pypi/simple"
134139
```
135140

136-
!!! note "网络环境"
141+
:::tip 网络环境
142+
:::
143+
137144
`shell
138145
unset http_proxy && unset https_proxy
139146
`
@@ -285,7 +292,9 @@ bash Miniconda3-py39_24.7.1-0-Linux-aarch64.sh
285292

286293
[conda 使用指南](https://blog.csdn.net/miracleoa/article/details/106115730)
287294

288-
!!! note " conda 和 pip 的区别"
295+
:::tip conda 和 pip 的区别
296+
:::
297+
289298
[Anaconda | Understanding Conda and Pip](https://www.anaconda.com/blog/understanding-conda-and-pip)
290299

291300
||conda|pip|
@@ -413,10 +422,12 @@ pdb.set_trace()
413422

414423
### CUDA
415424

416-
!!! note "什么是 CUDA"
425+
:::tip 什么是 CUDA
426+
417427
通俗地说,CUDA 是一种协助“CPU 任务分发+GPU 并行处理”的编程模型/平台,用于加速 GPU 和 CPU 之间的计算。
418428

419-
也就是说CUDA通过CPU任务分发和GPU并行处理的方式,把计算任务通过CPU分发给GPU进行并行计算加速。而GPU并行计算的能力需要CUDA借助其自带的编程接口和工具,比如C/C++语言来编写并行计算程序,并通过CUDA编译器将程序转化为可以在英NVIDIA GPU上执行的机器码快速运行。
429+
也就是说 CUDA 通过 CPU 任务分发和 GPU 并行处理的方式,把计算任务通过 CPU 分发给 GPU 进行并行计算加速。而 GPU 并行计算的能力需要 CUDA 借助其自带的编程接口和工具,比如 C/C++ 语言来编写并行计算程序,并通过 CUDA 编译器将程序转化为可以在英 NVIDIA GPU 上执行的机器码快速运行。
430+
:::
420431

421432
#### CUDA 版本的兼容性
422433

@@ -476,19 +487,23 @@ nvcc --version
476487
pip install torch==1.10.1+cu102 torchvision==0.11.2+cu102 torchaudio==0.10.1 -f https://download.pytorch.org/whl/cu102/torch_stable.html
477488
```
478489

479-
!!! failure "numpy 报错"
490+
:::warning numpy 报错
491+
480492
安装好 torch 之后,numpy 会报错
481493

482-
```
483-
UserWarning: Failed to initialize NumPy: _ARRAY_API not found (Triggered internally at ..\torch\csrc\utils\tensor_numpy.cpp:68.)
484-
_dtype_to_storage = {data_type(0).dtype: data_type for data_type in _storages}
485-
```
494+
```text
495+
UserWarning: Failed to initialize NumPy: _ARRAY_API not found (Triggered internally at ..\torch\csrc\utils\tensor_numpy.cpp:68.)
496+
_dtype_to_storage = {data_type(0).dtype: data_type for data_type in _storages}
497+
```
498+
499+
**解决方法:** 将 numpy 版本降低为非>2.0.0 的版本,之后就能成功导入了。
486500

487-
**解决方法:** 将 numpy 版本降低为非>2.0.0 的版本,之后就能成功导入了。
488-
```shell
489-
pip uninstall numpy
490-
pip install numpy==1.26
491-
```
501+
```shell
502+
pip uninstall numpy
503+
pip install numpy==1.26
504+
```
505+
506+
:::
492507

493508
```python title="测试是否可用"
494509
import torch # 如果 pytorch 安装成功即可导入
@@ -553,15 +568,17 @@ ln -s /usr/lib/aarch64-linux-gnu/libstdc++.so.6.0.30 libstdc++.so.6
553568

554569
### ImportError: No module named parse
555570

556-
!!! bug "ImportError: No module named parse"
571+
:::warning ImportError: No module named parse
557572
python 版本问题,在 python 2.x 中
558573

559-
```python
560-
from urlparse import urlparse
561-
```
574+
```python
575+
from urlparse import urlparse
576+
```
577+
578+
在 python 3.x
562579

563-
在python 3.x
580+
```python
581+
from urllib.parse import urlparse
582+
```
564583

565-
```python
566-
from urllib.parse import urlparse
567-
```
584+
:::

docs/Backend/rules.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# 常识
22

3-
!!! tip "这篇文章列举一些在产品开发中遇到的知识点和有用的技能"
3+
:::tip 这篇文章列举一些在产品开发中遇到的知识点和有用的技能
4+
5+
:::
46

57
## 开发过程
68

docs/Cloud/docker.md

Lines changed: 48 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
[Docker Compose - 安装和基本使用\_docker-compose 安装-CSDN 博客](https://blog.csdn.net/Que_art/article/details/135192479)
44

5-
=== "Docker Compose(容器编排工具)"
5+
:::info
66

7-
定义:Docker Compose 是一个用于定义和运行多容器 Docker 应用的工具。
7+
Docker Compose(容器编排工具):Docker Compose 是一个用于定义和运行多容器 Docker 应用的工具。
88

9-
功能:
10-
- **多容器管理**:允许用户在一个YAML文件中定义和管理多个容器
11-
- **服务编排**:配置容器间的网络和依赖关系
12-
- **一键部署**:使用docker-compose up命令启动、停止和
9+
功能:
10+
- **多容器管理**:允许用户在一个YAML文件中定义和管理多个容器
11+
- **服务编排**:配置容器间的网络和依赖关系
12+
- **一键部署**:使用docker-compose up命令启动、停止和
1313

14-
=== "Docker(容器平台)"
14+
Docker(容器平台):一个开放源代码的容器化平台,允许开发者将应用及其依赖打包进轻量级、可移植的容器中。
1515

16-
定义:一个开放源代码的容器化平台,允许开发者将应用及其依赖打包进轻量级、可移植的容器中。
17-
18-
- **容器化**:将应用和其运行环境封装在一个容器中
19-
- **镜像管理**:创建、存储和分发容器镜像
20-
- **容器运行**:可以运行在任何支持 Docker 的环境中
16+
功能:
17+
- **容器化**:将应用和其运行环境封装在一个容器中
18+
- **镜像管理**创建、存储和分发容器镜像
19+
- **容器运行**可以运行在任何支持 Docker 的环境中
20+
:::
2121

2222
## 安装
2323

@@ -151,40 +151,42 @@ sudo journalctl -u docker
151151

152152
### 文档
153153

154-
!!! note "文档结构"
155-
156-
=== "说明"
157-
158-
- version:指定 Compose 文件格式 yaml 的规则版本,版本决定可用的配置选项
159-
- service:定义了应用中的服务,每个服务可以使用不同的镜像、环境设置和依赖关系
160-
- web:自己构建的镜像
161-
- build:用于构建镜像,指定构建镜像的 dockerfile 的上下文路径
162-
- ports:映射容器和宿主机的端口
163-
- volumes:挂载本地目录到指定容器目录,用于数据持久化或在容器之间共享数据
164-
- links:与 redis 服务连接
165-
- redis:构建指定镜像 redis
166-
- image:从指定的镜像中启动容器,可以是存储仓库、标签以及镜像 ID
167-
- volumes:用于数据持久化和共享的数据卷定义,常用于数据库存储、配置文件、日志等数据的持久化
168-
169-
=== "实例"
170-
171-
```yml
172-
version: "3.9"
173-
services:
174-
web:
175-
build: .
176-
ports:
177-
- "8000:5000"
178-
volumes:
179-
- .:/code
180-
- logvolume01:/var/log
181-
links:
182-
- redis
183-
redis:
184-
image: redis
185-
volumes:
186-
logvolume01: {}
187-
```
154+
:::tip 文档结构
155+
156+
**说明:**
157+
158+
- version:指定 Compose 文件格式 yaml 的规则版本,版本决定可用的配置选项
159+
- service:定义了应用中的服务,每个服务可以使用不同的镜像、环境设置和依赖关系
160+
- web:自己构建的镜像
161+
- build:用于构建镜像,指定构建镜像的 dockerfile 的上下文路径
162+
- ports:映射容器和宿主机的端口
163+
- volumes:挂载本地目录到指定容器目录,用于数据持久化或在容器之间共享数据
164+
- links:与 redis 服务连接
165+
- redis:构建指定镜像 redis
166+
- image:从指定的镜像中启动容器,可以是存储仓库、标签以及镜像 ID
167+
- volumes:用于数据持久化和共享的数据卷定义,常用于数据库存储、配置文件、日志等数据的持久化
168+
169+
**实例:**
170+
171+
```yml
172+
version: "3.9"
173+
services:
174+
web:
175+
build: .
176+
ports:
177+
- "8000:5000"
178+
volumes:
179+
- .:/code
180+
- logvolume01:/var/log
181+
links:
182+
- redis
183+
redis:
184+
image: redis
185+
volumes:
186+
logvolume01: {}
187+
```
188+
189+
:::
188190
189191
```shell
190192
docker-compose up

0 commit comments

Comments
 (0)