这是一份随站点渲染器维护的写作参考。每节先展示实际效果,再给出可直接复制到文章里的 Markdown 源码。示例只使用 HeatLab 当前已启用的语法。

标题、段落与分隔线

标题会自动加入文章目录;正文中的二级和三级标题会显示在左侧导航。

三级标题示例

段落之间留一个空行即可。普通换行也会保留为换行效果。
这一句会显示在下一行。


## 标题、段落与分隔线

### 三级标题示例

段落之间留一个空行即可。普通换行也会保留为换行效果。
这一句会显示在下一行。

---

文字强调与链接

这是 加粗文字斜体文字inline code高亮文字。可使用 HeatLab 首页外部链接;外部地址请使用完整的 https:// URL。

这是 **加粗文字***斜体文字*`inline code` 与 ==高亮文字==。
可使用 [HeatLab 首页](/) 或 [外部链接](https://www.python.org/)。

列表与任务步骤

无序列表适合罗列概念:

  • 输入
  • 处理
  • 清洗数据
  • 运行分析
  • 输出

有序列表适合表示顺序:

  1. 准备环境。
  2. 运行命令。
  3. 检查输出。
无序列表适合罗列概念:

- 输入
- 处理
  - 清洗数据
  - 运行分析
- 输出

有序列表适合表示顺序:

1. 准备环境。
2. 运行命令。
3. 检查输出。

引用与提示框

普通引用适合摘录观点或原话:

好的笔记应当让未来的自己快速恢复上下文。

站点还支持 GitHub/Typora 风格的五类提示框:

Note

用于补充背景、定义或来源。

Tip

用于可立即采纳的小建议。

关键结论

用于不应被略过的前提、结果或决定。

Warning

用于可能造成失败或误解的条件。

Caution

用于不可逆操作和需要特别谨慎的风险。

> 好的笔记应当让未来的自己快速恢复上下文。

!!! note
    用于补充背景、定义或来源。

!!! tip
    用于可立即采纳的小建议。

!!! important "关键结论"
    用于不应被略过的前提、结果或决定。

!!! warning
    用于可能造成失败或误解的条件。

!!! caution
    用于不可逆操作和需要特别谨慎的风险。

代码块与语法高亮

无语言代码块适合纯文本、终端输出或词汇;阅读器会标为 TEXT

tedious: boring or too slow to enjoy

为代码块写上语言名,站点会显示语言标签、复制按钮和对应语法高亮:

def binary_search(items: list[str], target: str) -> int:
    low, high = 0, len(items) - 1
    while low <= high:
        middle = (low + high) // 2
        if items[middle] == target:
            return middle
        if items[middle] < target:
            low = middle + 1
        else:
            high = middle - 1
    return -1

常用的 rjavascriptpowershellshjsonsql 等语言名同样可用。

无语言代码块:

```
tedious: boring or too slow to enjoy
```

带语言的代码块:

```python
print("Hello, HeatLab")
```

数学公式

行内公式可写在句子中:二分查找的时间复杂度为 $T(n) = O(\log n)$。

独立公式用两个美元符号包围:

$$
\mathrm{steps}(n) = \lceil \log_2 n \rceil
$$

需要手动编号时,在公式内加入 \tag{...}

$$
\mathcal{L}(\theta) = \sum_i \ell_i \tag{1}
$$

行内公式:$T(n) = O(\log n)$。

$$
\mathrm{steps}(n) = \lceil \log_2 n \rceil
$$

$$
\mathcal{L}(\theta) = \sum_i \ell_i \tag{1}
$$

表格

表格适合字段、参数和结果的横向对比。移动端会在容器内横向滚动。

参数 示例值 说明
epochs 50 训练轮数
batch_size 32 每批样本数
learning_rate 0.001 优化器步长
| 参数 | 示例值 | 说明 |
| --- | ---: | --- |
| `epochs` | 50 | 训练轮数 |
| `batch_size` | 32 | 每批样本数 |
| `learning_rate` | 0.001 | 优化器步长 |

脚注

脚注适合放置不打断主叙述的补充信息。这里有一个例子1

脚注适合放置不打断主叙述的补充信息。这里有一个例子[^rendering]。

[^rendering]: HeatLab 使用 Python-Markdown 渲染文章,并在浏览器中用 MathJax 排版公式。

图片

将图片放到与文章同名的 images 文件夹后,使用相对路径插入。站点会在同步时索引图片尺寸,以减少阅读页面加载时的跳动。

![图片的替代文字](/content/assets/posts/hot-learning/images/HeatLab Markdown 阅读样式参考/文章文件名/示例图片.png)

图片替代文字应简洁描述图片内容;它会在图片无法加载时提供上下文,也有助于无障碍阅读。

写作约定

  • 正文首个 # 一级标题 会由页面标题替代,因此文章文件通常直接从 ## 二级标题 开始。
  • 标题不要跳级,例如在 ## 下使用 ###,以保持目录层级清晰。
  • 代码、公式、表格和提示框前后各留一个空行,避免被识别为普通段落。
  • 文章由 Markdown 源文件同步至站点数据库;请以 content/posts 内的文件作为编辑源。

  1. HeatLab 使用 Python-Markdown 渲染文章,并在浏览器中用 MathJax 排版公式。