写作与标记

页面使用 GitHub 风格的 Markdown 编写。这里描述的所有内容在 GitHub 上同样能够渲染，因此在仓库中阅读的页面与本站上的同一页面内容一致。

代码

用 moonbit（或 mbt）标记 MoonBit 代码块。接口摘录可以使用 mbti。

pub fn[S, A, B, C] Hom::then(self : Hom[S, A, B], next : Hom[S, B, C]) -> Hom[S, A, C] {
  trust(x => next.apply(self.apply(x)))
}

保持示例简短，并确保它们能够编译。与其给出多个片段，不如给出一个完整示例。

数学

使用 TeX 记法书写数学：行内用 $f(x + y) = f(x) + f(y)$，行间公式用 $$ 块。

$$\operatorname{Hom}(\mathbb{Z}, R) = \{\, \iota_R \,\}$$

数学公式不会被翻译。需要翻译的内容请写在公式周围的文字中。

旁注

脚注在宽屏上显示为旁注，在窄屏上仍为脚注。将它们用于读者可以跳过的备注：参考文献、历史说明、证明概要。¹1 就像这一条。将脚注定义写在使用它的段落之后。

提示框

对于读者绝不能错过的少数内容，使用 GitHub 提示：

提示的种类有 NOTE、TIP、IMPORTANT、WARNING 和 CAUTION。每位读者都需要知道的事实应写在正文中，而不是放在提示里。可选的补充说明使用普通引用块。

表格

对能够对齐排列的事实使用表格：签名与含义、选项与默认值。保持单元格简短；需要一整段文字的单元格应写进正文。

风格

• 使用现在时和主动语态。
• 对操作说明使用第二人称：“运行 lunadoc update。”
• 按代码中的名称称呼事物，并以代码形式书写：写 Hom::postulate，而不是“postulate 函数”。
• 当各项相互依赖时，用句子代替项目符号列表。

Footnotes

1. 就像这一条。将脚注定义写在使用它的段落之后。 ↩