Chirpy博客格式简介
在 Chirpy 项目中撰写博客时,通常使用 Markdown 格式,并结合 Jekyll 的前置元数据(Front Matter)来定义博客的标题、日期、分类等信息。以下是 Chirpy 博客撰写的基本格式总结:
1. 文件命名
- 博客文件通常以
.md为后缀。 - 文件名格式为:
YYYY-MM-DD-标题.md,例如2023-10-05-my-first-post.md。 - 文件名中的日期会被解析为博客的发布日期。
2. 前置元数据(Front Matter)
在 Markdown 文件的开头,需要使用 YAML 格式的前置元数据来定义博客的基本信息。以下是一个典型的 Front Matter 示例:
1
2
3
4
5
6
7
8
9
10
11
---
title: "你的博客标题" # 博客标题
date: 2023-10-05 # 发布日期
categories: [分类1, 分类2] # 博客分类
tags: [标签1, 标签2] # 博客标签
math: true # 是否启用数学公式支持
mermaid: true # 是否启用 Mermaid 图表支持
image:
path: /path/to/image # 博客封面图片路径
alt: 图片描述 # 图片描述
---
常用字段说明:
- title: 博客标题。
- date: 发布日期,格式为
YYYY-MM-DD。 - categories: 博客分类,可以是一个或多个。
- tags: 博客标签,可以是一个或多个。
- math: 是否启用数学公式支持(如 LaTeX)。
- mermaid: 是否启用 Mermaid 图表支持。
- image: 博客封面图片,包含
path和alt两个字段。
3. Markdown 内容格式
在 Front Matter 之后,使用 Markdown 语法撰写博客正文。以下是一些常用的 Markdown 语法:
标题
1
2
3
# 一级标题
## 二级标题
### 三级标题
段落和换行
1
2
3
4
这是一个段落。
这是另一个段落,
使用两个空格实现换行。
列表
- 无序列表: ```markdown
- 项目1
- 项目2
- 子项目 ```
- 有序列表: ```markdown
- 第一项
- 第二项 ```
链接和图片
1
2
[链接文字](https://example.com)

代码
- 行内代码:
1
这是 `行内代码` 示例。 - 代码块:
1 2 3
```python def hello(): print("Hello, World!")
```
引用
1
> 这是一个引用。
表格
1
2
3
| 列1 | 列2 | 列3 |
| --- | --- | --- |
| 数据1 | 数据2 | 数据3 |
分隔线
1
---
4. 扩展功能
Chirpy 支持一些扩展功能,可以通过 Front Matter 或插件启用:
数学公式
启用方式:在 Front Matter 中设置
math: true。示例:
1 2 3 4 5 6
这是一个行内公式:$E = mc^2$。 这是一个块级公式: $$ \int_a^b f(x)dx $$
Mermaid 图表
- 启用方式:在 Front Matter 中设置
mermaid: true。 - 示例:
1 2 3 4 5
graph TD; A-->B; A-->C; B-->D; C-->D;
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
5. 示例模板
以下是一个完整的 Chirpy 博客模板:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
---
title: "我的第一篇博客"
date: 2023-10-05
categories: [教程, 博客]
tags: [Markdown, Chirpy]
math: true
mermaid: true
image:
path: /assets/images/sample.jpg
alt: 示例图片
---
# 一级标题
这是我的第一篇博客。
## 二级标题
这是一个段落。
### 三级标题
- 无序列表项1
- 无序列表项2
1. 有序列表项1
2. 有序列表项2
[这是一个链接](https://example.com)

```python
def hello():
print("Hello, World!")
这是一个引用。
| 列1 | 列2 | 列3 |
|---|---|---|
| 数据1 | 数据2 | 数据3 |
这是一个行内公式:$E = mc^2$。
这是一个块级公式: \(\int_a^b f(x)dx\)
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
1
2
3
4
5
6
7
8
9
10
---
### 总结
- Chirpy 博客使用 Markdown 格式撰写,结合 Front Matter 定义元数据。
- 支持标题、列表、链接、图片、代码块、表格等 Markdown 语法。
- 扩展功能包括数学公式和 Mermaid 图表。
- 文件命名格式为 `YYYY-MM-DD-标题.md`。
希望这些总结能帮助你快速回忆起 Chirpy 博客的撰写格式!
本文由作者按照 CC BY 4.0 进行授权