跳转至

08 进阶语法

这一章的语法不是所有平台都支持,但主流编辑器(VS Code、Typora、Obsidian)和文档站框架(MkDocs、Docusaurus)基本都能用。

折叠块(Details)

点击展开/收起,适合放「长日志」「答案解析」「详细步骤」:

<details>
<summary>点击展开查看答案</summary>

这里是折叠起来的内容。

- 可以是列表
- 也可以是代码

</details>
点击展开查看答案 这里是折叠起来的内容。 - 可以是列表 - 也可以是代码

💡 中间的空行很重要——空行里包着的 Markdown 才会被渲染。

MkDocs Material 里还有更漂亮的写法(pymdownx.details 扩展):

??? note "点我展开"
    这里是内容,缩进四个空格。

???+ tip "默认展开的提示"
    `???+` 表示默认展开。

脚注

正文里打标记,文末自动生成注释:

Forge 需要 Java 17[^1],而 1.16 时代还在用 Java 8[^2]。

[^1]: 官方推荐使用 JDK 17。
[^2]: 具体版本随 Forge 版本变化。

渲染效果:Forge 需要 Java 171,而 1.16 时代还在用 Java 82。

Emoji

两种写法:

写法 例子 支持情况
直接贴字符 🐱 🎮 ✅ 几乎全平台(最省事,推荐)
短代码 :smile: :rocket: GitHub、MkDocs、部分编辑器

常用 Emoji 速查:

含义 Emoji 含义 Emoji
完成 ✅ 警告 ⚠️
错误 ❌ 提示 💡
重要 ❗ 禁止 🚫
文档 📄 代码 💻
链接 🔗 工具 🔧

⚠️ 短代码 :smile: 在不支持的平台会原样显示成 :smile:,所以正式文档建议直接贴 Emoji。

定义列表

词条 + 解释的形式(Python-Markdown / MkDocs 支持):

Forge
:   老牌的 Minecraft 模组加载器,生态最大。

NeoForge
:   从 Forge 分叉出来的社区版本。

Forge : 老牌的 Minecraft 模组加载器,生态最大。

NeoForge : 从 Forge 分叉出来的社区版本。

公式(数学)

行内公式用单个 $ 包住,独立公式用两个 $$。

行内:$E = mc^2$

独立:

$$
S = \pi r^2
$$

⚠️ 需要平台支持 MathJax / KaTeX。GitHub 支持 $...$,MkDocs 需要 pymdownx.arithmatex 扩展(本站未启用)。

流程图 / 时序图(Mermaid)

很多平台支持 ```mermaid 代码块:

```mermaid
graph LR
  A[提交答卷] --> B[保存记录]
  B --> C[AI 批改]
  C --> D[推送群消息]
```

GitHub、MkDocs(需扩展)、Obsidian、语雀都支持。不支持时会显示成一堆代码。

给元素加属性(attr_list)

MkDocs / Python-Markdown 的 attr_list 扩展允许给元素加样式:

![封面](cover.png){ width="500" }

段落文字
{ .text-center }

内嵌 HTML

Markdown 里可以直接写 HTML,两者能混排:

<div style="color:#e63946;font-weight:bold;">
  这是用 HTML 写的红色粗体文字
</div>

<kbd>Ctrl</kbd> + <kbd>S</kbd> 保存

渲染:Ctrl + S 保存

场景 建议
调字号/颜色/居中 用 HTML(Markdown 做不到)
复杂表格(合并单元格) 用 HTML <table>
换行 <br>
普通排版 优先用 Markdown,别一上来就 HTML

⚠️ 有些平台(GitHub Issue、聊天软件)会过滤掉 HTML,只显示源码。以纯文本为主最保险。

目录(TOC)

很多平台会自动生成目录,也有的是写一个占位符:

[TOC]
平台 目录
GitHub README 不支持自动目录,可手写锚点链接
MkDocs / Material 自动生成侧栏 + 可加 toc 扩展给标题加锚点
Typora 侧栏大纲
Obsidian 侧栏 + 大纲插件

语法支持速查

语法 GitHub 语雀/飞书 MkDocs 聊天软件
基础语法 ✅ ✅ ✅ 部分
表格 ✅ ✅ ✅ ❌
任务列表 ✅ ✅ ✅ ❌
折叠 details ✅ ✅ ✅ ❌
脚注 ✅ ✅ ✅ ❌
Emoji 字符 ✅ ✅ ✅ ✅
Mermaid ✅ ✅ 需扩展 ❌
公式 ✅ ✅ 需扩展 ❌

本章练习

  1. 写一个折叠块,里面放一段代码。
  2. 给一段话加两个脚注。
  3. 用 HTML 让一行字居中、变红。

下一章讲最常见的坑,以及中文写作规范。


  1. 官方推荐使用 JDK 17。 ↩

  2. 具体版本随 Forge 版本变化。 ↩