这是一篇示例笔记。它在 notes/ 目录里,push 之后就会出现在站点上。

发布一篇笔记只要三步

1
2
3
4
cd C:\Users\18372\Me\notes
git add -A
git commit -m "note: 第一篇笔记"
git push

Push 之后大约一两分钟,GitHub Actions 会构建并发布,然后你就能在站点上看到它。

文件开头的 front matter

文件最上面 --- 包起来的那一段叫 front matter,只有这几个字段有意义:

字段是否必填作用
title建议写文章标题;不写就用文件名
date建议写发布日期,格式 2026-10-05;不写则用 git 提交时间
tags可选标签,会出现在 /tags/ 页面
categories可选分类
summary可选列表页显示的摘要;不写则自动截取正文
draft可选写 true 就不会发布(见下一篇示例草稿)

正文支持的写法

表格、任务列表、脚注

  • 已经能用的写法
  • 表格
  • 你还没试过的写法

脚注长这样:Hugo 用的是 Goldmark,兼容 GitHub 风格的 Markdown1。

代码块

带行号和复制按钮:

1
2
3
4
def greet(name: str) -> str:
    return f"你好,{name}"

print(greet("世界"))

行内代码是 这样 写的。

引用

真正的简约不止删繁就简,而是在纷繁中建立秩序。

数学公式

用 $$...$$ 写独立成行的公式,用单个 $...$ 写行内公式。KaTeX 会按需渲染:

$$\int_{-\infty}^{\infty} e^{-x^2}\,dx = \sqrt{\pi}$$

行内也能写,比如质能方程 $E = mc^2$,或者 $\alpha + \beta = \gamma$。

页面里没有公式时不会加载 KaTeX,所以不用担心拖慢其他文章。

加图片

需要配图的笔记,把这篇写成一个文件夹:

notes/带图片的笔记/
├── index.md     ← 正文写在这里
└── 截图.png      ← 图片放同一个目录

然后正文里用相对路径引用:

1
![截图](截图.png)

这样在 GitHub 上和站点上都能正常显示。

想删掉这篇

直接删文件、commit、push 就行,站点会同步下线。命令:

1
2
Remove-Item "C:\Users\18372\Me\notes\notes\第一篇笔记.md"
git add -A; git commit -m "chore: 删掉示例笔记"; git push

  1. 这是脚注内容,会自动收在文章底部。 ↩︎