笔记 / guide

创建新笔记

学习如何创建和组织笔记内容

第 2 篇

2025/1/25

#使用指南 #创建笔记

创建新笔记#

本章将详细介绍如何在博客中创建和组织笔记。

文件结构#

笔记存放在 src/content/notes/ 目录下，按课程分类：

1
src/content/notes/
2
├── 课程名称1/
3
│   ├── 01-第一章.md
4
│   ├── 02-第二章.md
5
│   └── ...
6
├── 课程名称2/
7
│   └── ...
8
└── ...

创建步骤#

1. 创建课程文件夹#

首先，在 notes 目录下创建一个新的文件夹，用课程名称命名：

1
mkdir src/content/notes/算法进阶

命名建议：

使用清晰、简洁的名称
可以使用中文或英文
避免特殊字符

2. 创建笔记文件#

在课程文件夹中创建 Markdown 文件：

1
# 建议使用序号前缀，便于排序
2
touch src/content/notes/算法进阶/01-动态规划基础.md

3. 编写 Front Matter#

每个笔记文件必须包含 Front Matter（元数据）：

1
---
2
title: 动态规划基础          # 笔记标题
3
category: 算法进阶          # 课程分类（文件夹名）
4
order: 1                    # 显示顺序
5
date: 2025-01-25           # 创建日期
6
description: 介绍动态规划的基本概念和解题思路  # 简短描述
7
tags: [动态规划, 算法]      # 标签（可选）
8
draft: false                # 是否为草稿（可选，默认 false）
9
---
10

11
# 这里开始写笔记内容

Front Matter 字段说明#

必填字段#

title：笔记标题，显示在页面顶部
category：课程分类，必须与文件夹名称一致
order：排序序号，数字越小越靠前

可选字段#

date：创建或更新日期
description：简短描述，用于搜索和预览
tags：标签数组，便于分类检索
draft：设为 true 则不会在网站上显示
image：封面图片路径（相对于笔记文件）

示例：完整笔记#

1
---
2
title: 二分查找详解
3
category: 算法基础
4
order: 3
5
date: 2025-01-25
6
description: 深入理解二分查找算法的原理和应用
7
tags: [查找算法, 二分查找]
8
---
9

10
# 二分查找详解
11

12
## 算法原理
13

14
二分查找是一种高效的查找算法，时间复杂度为 O(log n)。
15

16
### 基本思想
17

18
在有序数组中，通过比较中间元素来缩小查找范围...
19

20
## 代码实现
21

22
\`\`\`python
23
def binary_search(arr, target):
24
    left, right = 0, len(arr) - 1
25

26
    while left <= right:
27
        mid = (left + right) // 2
28
        if arr[mid] == target:
29
            return mid
30
        elif arr[mid] < target:
31
            left = mid + 1
32
        else:
33
            right = mid - 1
34

35
    return -1
36
\`\`\`
37

38
## 复杂度分析
39

40
- **时间复杂度**：O(log n)
41
- **空间复杂度**：O(1)
42

43
## 应用场景
44

45
1. 有序数组中查找元素
46
2. 查找插入位置
47
3. 旋转数组问题
48
...

注意事项#

Category 命名#

category 字段的值必须与文件夹名完全一致：

1
✅ 正确
2
文件夹：notes/算法基础/
3
Front Matter: category: 算法基础
4

5
❌ 错误
6
文件夹：notes/算法基础/
7
Front Matter: category: algorithm  # 不一致！

Order 排序#

order 值决定笔记的显示顺序：

1
01-introduction.md    → order: 1
2
02-basics.md          → order: 2
3
03-advanced.md        → order: 3

文件名规范#

虽然文件名不影响显示，但建议：

使用序号前缀（如 01-、02-）
使用有意义的英文名或拼音
避免空格和特殊字符

下一步#

现在你已经学会了如何创建笔记，接下来我们将学习如何编写丰富的笔记内容。

笔记系统介绍

编写笔记内容