Markdown 基础语法完整指南
1 标题
使用 `#` 符号表示标题级别,`#` 代表一级标题,`##` 代表二级标题,以此类推。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
2 文字格式
**加粗**:使用 `**` 或 `__` 包围文字,例如 `**加粗文字**` 或 `__加粗文字__`。
*斜体*:使用 `*` 或 `_` 包围文字,例如 `*斜体文字*` 或 `_斜体文字_`。
***加粗斜体***:使用 `***` 或 `___` 包围文字,例如 `***加粗斜体文字***` 或 `___加粗斜体文字___`。
3 列表
无序列表:使用 `-`、`*` 或 `+` 表示无序列表项,例如:
- 项目一
- 项目二
- 子项目
* 项目二
+ 项目三
有序列表:使用数字加点表示有序列表项,例如:
1. 第一项
2. 第二项
1. 子项
3. 第三项
4 链接和图片
<!-- 行内链接 -->
[链接文本](https://example.com)
<!-- 带标题的链接 -->
[链接文本](https://example.com "标题文字")
<!-- 引用式链接 -->
[链接文本][1]
[1]: https://example.com
<!-- 图片 -->


<!-- Hugo 特色 - 使用站点资源 -->
{{< figure src="image.jpg" title="图片标题" >}}
5 引用
使用 `>` 符号表示引用块,例如:
> 这是一个引用块
> 可以多行写作
>
> > 嵌套引用
>
> 引用结束
高级语法
代码块
```
<!-- 行内代码 -->
使用 `console.log()` 函数
```
<!-- 代码块 -->
```javascript
function hello() {
console.log("Hello, World!");
}
```
```python
def hello():
print("Hello, World!")
```
<!-- 带标题的代码块 -->
```go {linenos=true,hl_lines=[2,"4-5"],linenostart=199}
// Hugo 高亮特色
package main
import "fmt"
func main() {
fmt.Println("Hello, World!")
}
```
7 表格
| 左对齐 | 居中对齐 | 右对齐 |
| :----- | :------: | -----: |
| 单元格 | 单元格 | 单元格 |
| 第二行 | 数据 | 数据 |
<!-- 简化写法 -->
左对齐 | 居中对齐 | 右对齐
:--- | :---: | ---:
内容 | 内容 | 内容
8 脚注
这是一个脚注示例[^1]。
[^1]: 这是脚注的内容,可以包含更多信息。
[^2]: 这是第二个脚注的内容。
Hugo 特色功能
9 Front Matter (文章元数据)
---
title: "文章标题"
date: 2024-01-15T10:00:00+08:00
draft: false
tags: ["Markdown", "Hugo", "教程"]
categories: ["技术"]
description: "文章描述"
slug: "custom-url"
keywords: ["关键词1", "关键词2"]
---
10 短代码 (Shortcodes)
<!-- 提醒框 -->
{{< alert warning >}}
这是一个警告信息
{{< /alert >}}
<!-- 图片画廊 -->
{{< gallery >}}
{{< figure src="image1.jpg" caption="图片1" >}}
{{< figure src="image2.jpg" caption="图片2" >}}
{{< /gallery >}}
<!-- YouTube 视频 -->
{{< youtube abcdefg >}}
<!-- 自定义短代码 -->
{{< myshortcode param="value" >}}
内容
{{< /myshortcode >}}
11 数学公式
<!-- 行内公式 -->
这是行内公式 $E = mc^2$
<!-- 块级公式 -->
$$
\begin{aligned}
f(x) &= \int_{-\infty}^\infty \hat f(\xi),e^{2 \pi i \xi x} \\, d\xi
\end{aligned}
$$
12 图表 (Mermaid)
```mermaid
graph TD;
A[开始] --> B{判断}
B -->|是| C[执行]
B -->|否| D[结束]
C --> D
```
13 文章结构示例
---
title: "技术文档总览"
date: 2025-01-15T10:00:00+08:00
type: docs
weight: 1
description: "这里主要是给我几个必要的技术文档,包括Go语言, WordPress, 还有MaccmsRust的教程。"
slug: "technical-docs-overview" # ⭐ 改为唯一的slug
tags: ["wordpress", "Hugo", "教程"]
categories: ["技术文档"]
keywords: ["技术文档", "maccmsrust", "Go语言"]
---
# 一级标题
这是文章的引言部分。
## 二级标题
这里是正文内容。
### 三级标题
- 列表项一
- 列表项二
> 这是一个引用块。
最佳实践
7.1 文件命名
- 使用小写字母和连字符
- 避免使用空格和特殊字符
- 示例:markdown-tutorial.md
7.2 格式规范
- 标题前后空一行
- 列表项统一使用一种符号
- 表格保持对齐
- 代码块指定语言
7.3 内容组织
- 清晰的标题结构
- 适当的段落划分
- 重要的内容加粗强调
- 代码示例提供完整上下文
结语
掌握Markdown语法可以大大提升你的写作效率和内容质量。无论是撰写技术文档、博客文章,还是日常笔记,Markdown都是一个强大且易用的工具。希望这份完整指南能帮助你更好地利用Markdown进行创作!
关键要点:
- 嵌套层级:用4个反引号包裹包含代码块的内容
- 格式统一:每个示例都用代码块包裹
- 缩进一致:保持统一的缩进格式
- 语法正确:确保所有Markdown语法都正确嵌套
这样写出来的Markdown文件既能展示语法,又能正确渲染显示效果。