執筆とマークアップ

ページは GitHub Flavored Markdown で書きます。ここで説明する内容はすべて GitHub 上でも表示できるため、リポジトリで読むページとこのサイトの同じページは同じ内容になります。

コード

MoonBit のコードは、moonbit（または mbt）を指定したコードフェンスで囲みます。インターフェースの抜粋には 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)))
}

例は小さく保ち、必ずコンパイルできるようにします。断片をいくつも示すより、完全な例を 1 つ示すほうが望ましいです。

数式

数式は TeX 記法で書きます。インライン数式には $f(x + y) = f(x) + f(y)$、ディスプレイ数式には $$ ブロックを使います。

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

数式は翻訳されません。翻訳が必要な内容は、数式の前後の文章で表してください。

傍注

脚注は幅の広い画面では傍注になり、狭い画面では脚注のままです。参考文献、歴史的な補足、証明の概略など、読み飛ばしてもよい注記に使います。¹1 これがその例です。脚注の定義は、それを使う段落の直後に書きます。

注意書き

読者が決して見落としてはならない少数の事柄には、GitHub アラートを使います。

種類は NOTE、TIP、IMPORTANT、WARNING、CAUTION です。すべての読者が知るべき事実は、アラートではなく本文に書きます。任意の補足は通常の引用ブロックにします。

表

表は、シグネチャと意味、オプションとデフォルト値のように、並べて対応させられる事実に使います。セルは短くし、1 段落を要する内容は本文に書きます。

文体

• 現在形と能動態で書きます。
• 手順の説明には二人称を使います（「lunadoc update を実行してください。」）。
• ものはコードでの名前どおりに、コードとして書きます。「postulate 関数」ではなく Hom::postulate と書きます。
• 項目同士が依存し合う場合は、箇条書きより文章を使います。

Footnotes

1. これがその例です。脚注の定義は、それを使う段落の直後に書きます。 ↩