reStructuredText(reST)

reSTの書式リファレンス

文書のタイトルとサブタイトル

文書のタイトルとサブタイトルを示すには、文書の先頭で、 英数字以外の文字( = - ` : ' " ~ ^ _ * + # < > )で装飾した行を書く。 最初に出てきた装飾された行が文書のタイトルに、 次に出てきた異なる文字で装飾された行がサブタイトルになる。

見出し

英数字以外の文字で添線引きした行は、見出しとなる。 文字の種類や数に意味は無く、文書中に出てきた順でネストが下がる。

見出し 2.1

こんな

見出し 2.1.1

感じで

見出し 2.1.1.1

深くなっていく

見出し 2.2

ネスト戻り

文字スタイル

普通の文字、 斜体太文字等幅 。 スタイル指定の前後は、空白で区切ることが重要。 '*''`' のエスケープは、バックスラッシュ( '\' )で行う。

箇条書き

番号付きリスト

  1. あめんぼ
  2. あかいな
  3. あかさたな
  1. 入れ子にする場合は
  2. 段を下げて
  3. 上下に空行を入れて書きます
  1. 元のレベル

番号無しリスト

  • あめんぼ
  • あかいな
  • あかさたな
    • 入れ子にする場合は
    • 段を下げて
    • 上下に空行を入れて書きます
  • 元のレベル


カテゴリー:技術