Skip to main content

如何在我们的 wiki 中使用 Markdown (CommonMark)

注意:本文档是英文原版的自动翻译。

本页面是格式化我们 wiki 页面的简短“备忘单”,其中的内容是用 CommonMark Markdown 编写的。

基本规则

  • 简单、简短的句子 写作。
  • 使页面 易于浏览:标题 + 列表 + 表格。
  • 一个部分 = 一个想法。避免“大段文字”。

标题

使用 ## / ### / #### 构建结构。

## 部分
### 小节
#### 次小节

粗体、斜体、内联代码

**粗体**
*斜体*
`代码/字段/地址`

链接

[链接文本](https://example.com)

如果需要显示“原始”链接(罕见):

`https://example.com`

列表

无序列表:

- 项目 1
- 项目 2
  - 子项目

有序列表:

1. 步骤 1
2. 步骤 2
3. 步骤 3

引用 / 注意事项

> 这是一个重要的注意事项。
> 它可以有两行。

表格

最小模板:

| 字段 | 值 |
|---|---|
| 名称 | [ ] |
| 状态 | [ ] |

提示:

  • 分隔行 |---|---| 是必需的。
  • 表格单元格可以包含 **粗体**、链接和 代码

代码和“原始”文本块

代码块:

\```text
第 1 行
第 2 行
\```

如果是特定的语言(例如 JSON),您可以指定它:

\```json
{ "key": "value" }
\```

图片

如果您有直接的图片 URL:

![描述](https://example.com/image.png)

如果文件已上传到 wiki,请使用 wiki 在上传时提供的链接/嵌入代码。

换行和段落

  • 新段落是段落之间的 空行
  • 如果您需要在一个段落内换行,请在行尾添加两个空格:
第一行。  
第二行。

嵌入 HTML(谨慎使用)

可折叠的“详细信息”块

用于长篇详细信息/证据,以避免使“首屏”过载。

<details>
<summary><b>详细信息</b></summary>

您可以在这里放置文本、列表和表格。

</details>

页面内的锚点和快速链接

锚点:

<a id="ai-thesis-fit"></a>

链接到锚点:

[跳转到 AI 论点契合度](#ai-thesis-fit)

模板中的占位符

在模板中我们使用:

  • [ ] — “填写”
  • / — “— / 不适用”(当有意义时)
  • YYYY‑MM‑DD — 日期格式
  • Tier‑1/2/3 — 来源层级(证据/背景/噪音)

常见错误

  • 混淆信息框和描述:信息框只包含简短的事实;解释应放在页面正文中。
  • 在应该有来源的地方没有来源 进行写作。
  • 使“首屏”过载:长篇细节最好放在 <details> 中。
  • 使用“金融语言”(买入/卖出/持有建议、预测)——这对我们来说是被禁止的;我们只写事实/风险/需要验证的内容。

发布前的迷你检查清单

  • 是否有 1-2 行解释“这是什么”?
  • 是否有主要来源的链接?
  • 是否有任何“不清楚”的空表格字段(每个字段要么是一个值,要么是 —/—)?
  • Last verified 是否已填写?