跳转至

Markdown编辑与语法

本章节将指导你学习Markdown的基础知识和常用语法，以便你能够编辑和创建简历、博客等内容。

什么是Markdown

Markdown是一种轻量级标记语言，创建于2004年，目的是提供一种易读易写的纯文本格式，可以轻松转换为HTML和其他格式。它具有以下特点：

  • 易学易用：语法简单直观
  • 纯文本格式：使用任何文本编辑器都可以编辑
  • 专注内容：让你专注于写作内容，而不是格式
  • 广泛支持：被GitHub、Stack Overflow、简书等众多平台支持

Markdown编辑器

虽然可以使用任何文本编辑器编写Markdown，但专用的Markdown编辑器提供了更好的体验：

  • VS Code：安装Markdown预览插件后非常好用
  • Typora：所见即所得的Markdown编辑器
  • MarkText：开源的所见即所得编辑器
  • Obsidian：笔记应用，支持双向链接

对于初学者，我们推荐使用VS Code，因为在前面的章节中我们已经安装了它。

在VS Code中编辑Markdown

  1. 安装"Markdown All in One"和"Markdown Preview Enhanced"插件
  2. 创建.md文件
  3. 编辑内容
  4. 按Ctrl+K V（Windows/Linux）或Cmd+K V（macOS）打开侧边预览

Markdown基础语法

下面介绍Markdown的基础语法，这些是你需要掌握的核心内容。

标题

Markdown使用#符号来定义标题：

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

注意：#后应该有一个空格。

段落与换行

段落之间空一行即可。如果需要在段落内换行，使用两个或更多空格加回车：

这是第一段文字。

这是第二段文字。

这是第三段文字。  
这是第三段文字的新行。

强调

*斜体* 或 _斜体_
**粗体** 或 __粗体__
***粗斜体*** 或 ___粗斜体___
~~删除线~~

效果： - 斜体 - 粗体 - 粗斜体 - ~~删除线~~

列表

无序列表使用-、*或+作为标记：

- 项目1
- 项目2
  - 子项目A
  - 子项目B

有序列表使用数字加点：

1. 第一项
2. 第二项
   1. 子项1
   2. 子项2

链接

创建链接的格式为[链接文本](URL)：

[GitHub](https://github.com)

效果：GitHub

图片

插入图片的格式与链接类似，只是前面加一个!：

![图片说明](图片URL)

例如：

![示例图片](https://via.placeholder.com/150)

引用

使用>符号创建引用：

> 这是一段引用文字。
> 
> 这是引用的第二段。

效果：

这是一段引用文字。

这是引用的第二段。

代码

行内代码使用反引号包围：

使用 `print("Hello World")` 输出文本

代码块使用三个反引号包围，可以指定语言以启用语法高亮：

```python
def hello():
    print("Hello, World!")
```

分隔线

使用三个或更多的连字符、星号或下划线创建分隔线：

---
***
___

高级Markdown语法

除了基础语法外，以下是一些高级用法，可以让你的Markdown文档更加丰富。

表格

使用|分隔列，使用-分隔表头和内容：

| 姓名 | 年龄 | 职业 |
| --- | --- | --- |
| 张三 | 25 | 工程师 |
| 李四 | 28 | 设计师 |

效果：

姓名 年龄 职业
张三 25 工程师
李四 28 设计师

对齐方式： - :--- 左对齐 - :---: 居中对齐 - ---: 右对齐

任务列表

使用- [ ]和- [x]创建任务列表：

- [x] 完成任务1
- [ ] 待办任务2
- [ ] 待办任务3

效果： - [x] 完成任务1 - [ ] 待办任务2 - [ ] 待办任务3

脚注

添加脚注的语法：

这里有一个脚注[^1]。

[^1]: 这是脚注的内容。

目录

许多Markdown处理器支持自动生成目录：

[TOC]

或：

* TOC
{:toc}

在Pelican中使用Markdown

Pelican默认支持Markdown格式的内容文件。在Pelican项目中，Markdown文件通常放在content目录下，文件扩展名为.md。

Markdown文件元数据

Pelican的Markdown文件开头通常包含元数据，用于定义文章的标题、日期、分类等信息：

Title: 我的简历
Date: 2023-12-01 10:00
Category: 个人
Tags: 简历, 求职
Slug: my-resume
Author: 你的名字
Summary: 这是我的个人简历

<!-- 这里开始是正文内容 -->

# 个人信息

姓名：...

编辑简历内容

编辑你的简历Markdown文件，可以包含以下部分：

# 个人信息

- **姓名**：你的名字
- **邮箱**：your.email@example.com
- **电话**：+86 123 4567 8910
- **GitHub**：[你的GitHub](https://github.com/你的用户名)

# 教育背景

## XX大学 | XX专业 | 学士学位
*2018年9月 - 2022年6月*

- GPA: 3.8/4.0
- 相关课程：...

# 工作经验

## XX公司 | 软件工程师
*2022年7月 - 至今*

- 负责...
- 开发...
- 优化...

# 技能

- **编程语言**：Python, JavaScript, Java
- **框架**：Django, React, Spring Boot
- **工具**：Git, Docker, VS Code
- **语言**：中文（母语），英语（流利）

使用VS Code的Markdown扩展功能

VS Code的Markdown All in One插件提供了许多实用功能：

  1. 快捷键：
  2. Ctrl+B：粗体
  3. Ctrl+I：斜体
  4. Alt+S：删除线
  5. Ctrl+Shift+]：提高标题级别

  6. Ctrl+Shift+[：降低标题级别

  7. 自动补全：

  8. 列表项

  9. 表格格式

  10. 目录生成：

  11. 使用命令面板Ctrl+Shift+P，输入"Create Table of Contents"

常见问题及技巧

  1. 图片路径：对于本地图片，使用相对路径 

    ![图片说明](./images/图片名.jpg)

  2. 换行问题：记住段落间需要空行，行内换行需要两个空格加回车

  3. 转义字符：使用反斜杠\转义特殊字符 

    \*这不是斜体\*

  4. HTML兼容：Markdown支持内嵌HTML 

    <span style="color: red;">这是红色文字</span>

至此，你已经掌握了Markdown的基本语法和使用方法。下一章我们将学习如何创建GitHub Pages个人主页仓库。