Markdown 完整语法指南

微信扫一扫,分享到朋友圈

Markdown 完整语法指南

础语法

1. 标题

# 一级标题 (H1)
## 二级标题 (H2)
### 三级标题 (H3)
#### 四级标题 (H4)
##### 五级标题 (H5)
###### 六级标题 (H6)

2. 文字格式

**粗体文本** 或 __粗体文本__
*斜体文本* 或 _斜体文本_
***粗斜体*** 或 ___粗斜体___
~~删除线文本~~
==高亮文本== (部分编辑器支持)

3. 列表

无序列表

- 项目一
- 项目二
  - 子项目一
  - 子项目二
* 另一种符号
+ 还有一种符号

有序列表

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

任务列表

- [ ] 未完成任务
- [x] 已完成任务
- [ ] 另一个任务

4. 链接和图片

<!-- 行内链接 -->
[链接文本](https://example.com)

<!-- 带标题的链接 -->
[链接文本](https://example.com "标题文字")

<!-- 引用式链接 -->
[链接文本][1]
[1]: https://example.com

<!-- 图片 -->
![图片描述](image.jpg)
![图片描述](image.jpg "可选标题")

<!-- Hugo 特色 - 使用站点资源 -->
{{</* figure src="image.jpg" title="图片标题" */>}}

5. 引用块

> 这是一个引用块
> 可以多行写作
>
> > 嵌套引用
> 
> 引用结束

高级语法

6. 代码相关

<!-- 行内代码 -->
使用 `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]。

另一个脚注[^2]。

[^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
```

文章结构示例

---
title: "我的第一篇 Hugo 文章"
date: 2024-01-15
tags: ["教程", "Markdown"]
categories: ["技术"]
draft: false
---


---
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语言"]
---


# {{ title }}

## 引言

这是我的第一篇使用 **Hugo** 和 *Markdown* 写的文章。

## 主要内容

### 特性介绍

- 🚀 快速生成静态网站
- 📝 使用 Markdown 写作
- 🎨 丰富的主题选择
- 🔧 高度可定制

### 代码示例

```python
def hello_hugo():
    print("欢迎使用 Hugo!")

数据表格

功能支持情况备注
Markdown✅ 完全支持标准语法
短代码✅ 完全支持Hugo 特色
数学公式⚠️ 部分支持需要配置

总结

Hugo 是一个强大的静态网站生成器,适合技术博客写作。


## 🎨 实用写作技巧

### 内容组织
```markdown
<!-- 使用注释分隔章节 -->
<!-- 第一章开始 -->
## 第一章

内容...

<!-- 第二章开始 -->  
## 第二章

内容...

外部内容嵌入

<!-- Twitter -->
{{</* tweet user="SanDiegoZoo" id="1453110110599868418" */>}}

<!-- Instagram -->
{{</* instagram BWNjjyYFxVx */>}}

<!-- GitHub Gist -->
{{</* gist spf13 7896402 */>}}

内容提醒

{{</* notice note */>}}
这是一个提示信息
{{</* /notice */>}}

{{</* notice warning */>}}
这是一个警告信息  
{{</* /notice */>}}

{{</* notice tip */>}}
这是一个技巧提示
{{</* /notice */>}}

⚠️ 常见注意事项

  1. 空格重要:列表、代码块前后需要空行
  2. 特殊字符:使用反斜杠转义 \* \_ \#
  3. 中文排版:中英文间加空格,使用正确标点
  4. 图片路径:Hugo 中使用相对路径或资源目录

这个指南涵盖了 Hugo 环境中写作所需的全部 Markdown 语法,收藏起来随时查阅吧!

Markdown 完整语法指南
展开阅读全文
上一篇

安装完hugo无法使用1313测试解决办法

你也可能喜欢

  • 暂无相关文章!

评论已经被关闭。

插入图片
返回顶部