目录

↑ 返回顶部

markdown 写作格式参考

NO.0 Markdown 基本语法与写作习惯养成 链接到标题

Markdown 基本语法可参考 markdown 官网

部分常用语法 链接到标题

标题 链接到标题 


# 标题1

## 标题2

### 标题3

文字变体 链接到标题

加粗文字

斜体文字

加粗斜体文字


**加粗**文字

*斜体*文字

***加粗斜体文字***

列表 链接到标题

  • 列表 1
  1. 列表 2

引用


- 列表1

1. 列表2

> 引用

分割线 链接到标题

*** （分割线 1）

— （分割线 2）

图片和外链 链接到标题

图片名

网站

<网站链接>


![图片名](图片链接)

[网站](网站链接)

<网站链接>

表格 链接到标题

列 1 列 2 列 3
内容 1 内容 2 内容 3
内容 4 内容 5 内容 6

该表格用:控制对齐方式


| 左对齐 | 居中对齐 | 右对齐 | 默认(居中) |
|:-------|:-------:|-------:||-------|
| 内容1 | 内容2 | 内容3 | 内容4 |
| 内容5 | 内容6 | 内容7 | 内容8 |

Markdown 插入代码块 链接到标题

这个叫做语法高亮提示

```python

#!/usr/bin/python3
print("Hello, World!");

```

C#：


// 播放控制
mediaPlayer.Control.Play();//播放
mediaPlayer.Control.Pause();//暂停
mediaPlayer.Control.Stop();//停止
mediaPlayer.Control.Rewind();//回到视频第一帧

Json:

{
  "error": {
    "message": "我正在更改实例数据",
    "type": "authentication_error",
    "param": null,
    "code": "invalid_request_error"
  }
}

PS：其实写 C# 和 Json Hugo也能正常识别，但是其他的就不一定了！还是要养成良好的写作习惯

HTML 语言与 Markdown 的联动 链接到标题 


<br> 换行

Markdown 段首缩进 链接到标题

  or   表示一个半角的空格

  or   表示一个全角的空格

   两个全角的空格（用的比较多）

  or   不断行的空白格

写作习惯推荐 链接到标题

  • 好好排版

    • 中英文混用时，建议在英文单词前后加上空格方便阅读

    • 中英文逗号/句号等最好不要混用，强迫症震怒（）

NO.1 认识 Hugo 文章开头的各项参数 链接到标题

2025.9.16 修改：此处文章使用的 TOML 格式可能已过时，需要给时间加上引号才能通过编译，现创建文章建议使用解析器更宽松的 YAML 格式

2026.2.9更新：需要修改默认生成文章的格式的话，在本地的archrtypes文件夹中增加自己需要的格式就可以，里面的default就是默认生成文章的格式，如果添加了新的格式那么默认使用新格式生成文章

YAML 格式示例：(其实就是将=符号改为:符号后，再将+++改为—即可)

YAML格式示例

或者在创建文章时使用 YAML 格式：


hugo new posts/my-article.md --format yaml

或在站点根目录的 config.toml / config.yaml / config.json 里，添加配置：


### 如果用 config.toml
frontmatterFormat = "yaml"


### 如果用 config.yaml
frontmatterFormat: yaml

以下为本篇文章在终端中输入 Hugo new posts/Hugo 文章写作指南.md 时自动生成的文章参数

参数参考

draft = true 文章是否为草稿状态

  • true：草稿，Hugo 默认不会生成/发布

    • 然而实际测试时，draft 为 true 文章也正常发布了，待进一步测试中……
    • 2026.3.9 补充：上文中提及的草稿被一并发布的原因是使用了 hugo -D 命令来构建内容，这段的意思是构建时包含草稿，如果使用 hugo 命令就不会构建草稿，忘记更新这段了……
    • 顺便一提， hugo server -D 就是本地预览(带草稿), hugo server 是不带草稿的预览

  • false：正式文章，会被发布

date = 2025-04-08T20:09:27+08:00 文章创建/发布时间

ps：本篇文章的时间在测试时被修改过

  • 格式：ISO 8601 标准时间格式

  • +08:00 表示东八区（中国时区）

  • 影响文章排序和发布时间判断

title = “Hugo 文章写作指南” 文章标题（支持特殊字符和中文）

  • 会显示为文章页标题

slug = “1” _自定义 URL 路径

  • 留空时 Hugo 会从 title 自动生成

    • 像标题这样写，最后会显示为:

    slug1

    • 不填写，自动生成的显示结果:

    slug2

authors = [“NonoNoe”] 作者列表（数组格式

  • 需要与 config 中定义的作者标识匹配

  • 支持多作者：[作者 1, 作者 2]

因为作者列表是数组格式，数组格式中的字符串一定要记得加引号，否则会报错

tags = [“Hugo”] 标签(同为数组格式)

  • 用于内容分类

  • 一篇文章可以有多个标签

如果里面需要填写中文字符串，也要记得加引号

categories = [] 分类目录（数组格式）

  • 比 tags 更宽泛的分类

  • 示例：[“技术”, “计算机图形学”]

externalLink = “” 外部链接（跳转 URL 用）

  • 设置后文章会直接跳转到指定链接

  • 留空表示正常生成文章页

series = [] 系列文章分组

  • 用于关联多篇系列文章

  • 示例：[“图形学入门”]

被关联的文章会显示在文章底部，如下所示

参考

Markdown 代码块与语法高亮

NO.2 发布 Hugo 文章的方式 链接到标题

hugo -D

文章草稿会被一起发布，去掉后缀则反之

NO.3 Hugo 魔法变量 链接到标题

Hugo 模板系统提供了一些内置变量可直接使用，通常使用 {{}} 包裹