Skip to content

Commit 827abe5

Browse files
📝 更新文档内容,优化高亮提示与工具使用说明
- 在数据库文档中统一了高亮提示的颜色,提升了视觉一致性。 - 在Markdown和Terminal文档中增加了选项卡和高亮提示的使用示例,增强了内容的实用性和可读性。 - 更新了Python文档,增加了对相关库的推荐,提升了用户对库的理解和使用指导。
1 parent 7ca06ed commit 827abe5

22 files changed

+1476
-1121
lines changed

docs/docs/后端通识/数据库.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: 数据库
1212
SQL(结构化查询语言)是操作关系型数据库的标准语言。不同数据库的SQL语法90%相同,学会一种即可触类旁通。
1313

1414
**推荐学习资源**
15-
- <Highlight color="#96cf54">[SQLBolt](https://sqlbolt.com/) - 交互式SQL教程(1-2小时快速入门)</Highlight>
15+
- <Highlight color="#009400">[SQLBolt](https://sqlbolt.com/) - 交互式SQL教程(1-2小时快速入门)</Highlight>
1616
- [W3Schools SQL](https://www.w3schools.com/sql/) - 中文入门教程
1717
- [LeetCode数据库题](https://leetcode.com/problemset/database/) - 实战练习
1818

@@ -38,7 +38,7 @@ SELECT * FROM table1 JOIN table2 ON table1.id = table2.id;
3838

3939
### 关系型数据库 - PostgreSQL
4040

41-
<Highlight color="#96cf54">**推荐用于:结构化数据存储、复杂查询、向量检索(pgvector)**</Highlight>
41+
<Highlight color="#009400">**推荐用于:结构化数据存储、复杂查询、向量检索(pgvector)**</Highlight>
4242

4343
**核心特点**
4444
- 支持JSON、数组等丰富数据类型
@@ -72,7 +72,7 @@ LIMIT 5;
7272

7373
### 文档数据库 - MongoDB
7474

75-
<Highlight color="#96cf54">**推荐用于:非结构化数据、日志存储、快速原型开发**</Highlight>
75+
<Highlight color="#009400">**推荐用于:非结构化数据、日志存储、快速原型开发**</Highlight>
7676

7777
**核心特点**
7878
- 存储JSON格式文档,灵活的schema
@@ -106,7 +106,7 @@ db.conversations.insert_one({
106106

107107
### 内存数据库 - Redis
108108

109-
<Highlight color="#96cf54">**推荐用于:缓存、会话管理、实时排行榜**</Highlight>
109+
<Highlight color="#009400">**推荐用于:缓存、会话管理、实时排行榜**</Highlight>
110110

111111
**核心特点**
112112
- 微秒级响应速度(内存存储)
@@ -142,7 +142,7 @@ cached = r.get('cache:key123')
142142

143143
## 向量数据库
144144

145-
<Highlight color="#96cf54">**推荐用于:Embedding存储、语义搜索、相似度检索**</Highlight>
145+
<Highlight color="#009400">**推荐用于:Embedding存储、语义搜索、相似度检索**</Highlight>
146146

147147
向量数据库是专门用于处理高维向量数据的数据库系统。
148148

@@ -279,7 +279,7 @@ for content, distance in results:
279279

280280
根据项目需求,建议掌握:
281281

282-
1. <Highlight color="#96cf54">**优先掌握**:PostgreSQL(含pgvector)+ Redis</Highlight>
282+
1. <Highlight color="#009400">**优先掌握**:PostgreSQL(含pgvector)+ Redis</Highlight>
283283
2. **推荐了解**:MongoDB、向量数据库(Pinecone/Chroma)
284284
3. **了解即可**:MySQL、SQLite
285285

@@ -294,7 +294,7 @@ for content, distance in results:
294294

295295
### 推荐资源
296296

297-
- <Highlight color="#96cf54">[SQLBolt](https://sqlbolt.com/) - SQL快速入门</Highlight>
297+
- <Highlight color="#009400">[SQLBolt](https://sqlbolt.com/) - SQL快速入门</Highlight>
298298
- [PostgreSQL官方文档](https://www.postgresql.org/docs/)
299299
- [pgvector GitHub](https://github.com/pgvector/pgvector)
300300
- [Redis官方文档](https://redis.io/docs/)

docs/docs/编程外的基础/Markdown.mdx

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ description: Markdown和MDX的各种用法及示例
88

99
### MDX
1010

11-
MDX 允许在 <Highlight >Markdown</Highlight> 内容中使用 <Highlight >JSX</Highlight> 来<Highlight color="#96cf54">高亮文本</Highlight>。也可以导入例如:鼠标悬浮展示这样的<HoverText text="组件" explanation="(如交互式图表或警报),并将其嵌入到内容中。这使得编写包含组件的长篇内容变得非常有趣。"/>。
11+
MDX 允许高度自定义样式,例如像<HoverText text="鼠标悬浮展示" explanation="将需要说明的内容嵌入。这使得编写包含组件的长篇内容变得非常有趣。"/>。
1212

13-
也可以加载第三方组件
13+
也可以加载第三方思维导图组件,用于系统展示框架:
1414

1515
<MarkmapHooks initialMarkdown={`
1616
@@ -59,13 +59,71 @@ MDX 允许在 <Highlight >Markdown</Highlight> 内容中使用 <Highlight >JSX</
5959
6060
`} />
6161

62+
### 选项卡
63+
64+
import Tabs from '@theme/Tabs';
65+
import TabItem from '@theme/TabItem';
66+
67+
对比展示多种语言可以使用选项卡:
68+
69+
<Tabs>
70+
<TabItem value="Python" label="Python" default>
71+
使用Python打印Hello, World!
72+
```python showLineNumbers title="test.py"
73+
print("Hello, World!")
74+
```
75+
</TabItem>
76+
<TabItem value="C" label="C">
77+
使用C打印Hello, World!
78+
```c showLineNumbers {3} title="test.c"
79+
#include <stdio.h>
80+
int main(){
81+
printf("Hello, World!");
82+
return 0;
83+
}
84+
```
85+
</TabItem>
86+
<TabItem value="html" label="html">
87+
使用html展示Hello, World!
88+
```html showLineNumbers title="test.html"
89+
<p>Hello, World!</p>
90+
```
91+
</TabItem>
92+
</Tabs>
93+
94+
### 高亮提示
95+
96+
不同颜色的高亮提示:
97+
98+
这是行内<Highlight color="#e13238">危险提醒</Highlight>、<Highlight>警示提醒</Highlight>、<Highlight color="#009400">建议提醒</Highlight>、<Highlight color="#4cb3d4">信息提醒</Highlight>。
99+
100+
:::danger
101+
用于危险操作的警告。例如 `rm -rf /` 会删除所有文件。
102+
:::
103+
104+
:::warning
105+
用于警示操作的警告。例如 C语言中`5/2` 结果是 `2` 而不是 `2.5`
106+
:::
107+
108+
:::tip
109+
这是块级的建议提醒。例如 Python 中 type 有另外一个截然不同的用法,它是一个元类,用于创建类。
110+
:::
111+
112+
:::info
113+
这是块级的信息提醒。例如 技术演进的历史背景,辅助读者理解技术原理。
114+
:::
115+
116+
:::note
117+
这是块级的注解提醒。例如 福柯的《规训与惩罚》不仅是对现代社会的批判,也是对权力运作机制的深刻反思。其主要著作有:《规训与惩罚》、《疯癫与文明》、《性史》、《知识考古学》。
118+
119+
主要用在读书笔记中,类似注脚。
120+
:::
121+
62122
### 数学公式
63123

64-
$\Delta \delta\\$
65124
$\cos (2\theta) = \cos^2 \theta - \sin^2 \theta\\$
66125

67126
```markdown
68-
$\Delta \delta\\$
69127
$\cos (2\theta) = \cos^2 \theta - \sin^2 \theta\\$
70128
```
71129

docs/docs/编程外的基础/Terminal.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ sudo reboot # 以管理员身份重启系统
174174
| `mv` | 移动/重命名 | `mv old.txt new.txt` | **m**o**v**e |
175175
| `cat` | 查看文件内容 | `cat readme.txt` | con**cat**enate |
176176

177-
:::warning 危险命令
177+
:::danger
178178
`rm -rf /` 会删除所有文件!**永远不要**执行这个命令!
179179
- `-r`:递归删除(包括子目录)
180180
- `-f`:强制删除(不询问)

0 commit comments

Comments
 (0)