コンテンツにスキップ

RTM Wikiで使用する文法

RTM Wikiでは、ページはMarkdown形式の文書で構成されています。
そのため、ページの編集には、Markdownの文法の知識が必要です。

Markdownは、記号と文字を使用して書式付きテキストを作成するためのフォーマットです。
当初は、ウェブサイトに使用するHTMLに変換されることが想定されていましたが、Microsoft WordやPowerPoint、PDFなど様々な形式に変換できるようになりました。

文書の見出しを作成するには、半角の番号記号#U+0023)を使用します。

#の数によって、見出しのレベルを変更することができます。
見出しのレベルには1から6があり、より上位の内容とそれに属する下位の内容と言うように使い分ける必要があります。

例えば、今見ているこのページでは、レベル2の「見出し」と、それに属するレベル3の「見出しの階層構造」というように、文書全体の意味と構造を考慮して見出しが付与されています。

RTM Wikiでは、レベル1の見出しをページのタイトルで使用しているため、文章の中では、レベル2以下の見出しを使用してください。

文章の段落を作成するには、別の段落で区切る行の間に、1行空行を開けます。

「ごん、お前だったのか。いつも栗をくれたのは」
ごんは、ぐったりと目をつぶったまま、うなずきました。
兵十は火縄銃をばたりと、とり落しました。青い煙が、まだ筒口から細く出ていました。

「ごん、お前だったのか。いつも栗をくれたのは」

ごんは、ぐったりと目をつぶったまま、うなずきました。

兵十は火縄銃をばたりと、とり落しました。青い煙が、まだ筒口から細く出ていました。

同じ段落中で文を改行するには、ソースでも同様に改行します。

一般的なMarkdown文法では、改行の後に空白文字が必要ですが、RTM Wikiではソースでの改行がそのまま変換結果での改行に反映されるため、空白文字は不要です。

ハイパーリンクを作成するには、半角の角括弧[]と半角の丸括弧()を使用します。

表示されるテキストを角括弧[U+005B)と]U+005D)で囲み、その直後に丸括弧(U+0028)と)U+0029)で囲ったリンク先のURLを記載します。

また、テキストとリンク先が同じ場合には、URLを単独で記載することで省略できます

[ngt5479のTwitter](https://x.com/ngt5479)
https://x.com/ngt5479

ngt5479のTwitter

https://x.com/ngt5479

重要な部分を強調するには、アスタリスク*U+002A)を使用します。

ここはあまり重要じゃないです**ここは重要です**ここもあまり重要じゃないです

ここはあまり重要じゃないですここは重要ですここもあまり重要じゃないです

箇条書きリストを作成するには、行の先頭にハイフン-U+002D)と半角スペースを1つ入れ、項目の内容を書きます。

リストの階層を作るには、半角スペースを2つ以上インデント(字下げ)します。
上位項目に属する内容を下位項目として整理することができます。

**箇条書きリスト**
- ダチョウ
- ペリカン
- ブチクスクス
- パタスモンキー
**階層付きリスト**
- おさかな
- たんすいぎょ
- あゆ
- どじょう
- かいすいぎょ
- まぐろ
- おいしい
- おさかなじゃない
- ほにゅうるい
- くじら

箇条書きリスト

  • ダチョウ
  • ペリカン
  • ブチクスクス
  • パタスモンキー

階層付きリスト

  • おさかな
    • たんすいぎょ
      • あゆ
      • どじょう
    • かいすいぎょ
      • まぐろ
        • おいしい
  • おさかなじゃない
    • ほにゅうるい
      • くじら

手順や順序のある内容を表すには、番号付きリストを使用します。
行頭に数字とピリオド.U+002E)を記載し、その後に半角スペースを入れて内容を書きます。

1. 下準備をする
2. 材料を混ぜる
泡が立つまで混ぜます。
3. 焼き上げる
  1. 下準備をする
  2. 材料を混ぜる
    泡が立つまで混ぜます。
  3. 焼き上げる

他の文章や発言を引用するには、行の先頭に不等号>U+003E)を記載します。
複数行にわたる引用や、引用の中に別の要素を含めることも可能です。

> 「吾輩は猫である。名前はまだ無い。」
>
> 夏目漱石『吾輩は猫である』

「吾輩は猫である。名前はまだ無い。」

夏目漱石『吾輩は猫である』

プログラムコードやコマンドなどを記載するには、バッククォート `U+0060)を使用します。

文中の一部分をコードとして表示する場合は、コード部分をバッククォート1つで囲みます。

コマンドは `ls -la` を使用します。

コマンドは ls -la を使用します。

複数行のコードをまとめて記載する場合は、バッククォート3つ(`````)で囲みます。
コードブロックの開始行に言語名を指定すると、構文強調(シンタックスハイライト)が有効になります。

```js
function hello() {
console.log('hello');
}
`​``
function hello() {
console.log('hello');
}

画像を表示するには、ハイパーリンクの文法の先頭に感嘆符!U+0021)を付けます。
角括弧内に代替テキスト(altテキスト)を記載し、丸括弧内に画像のURLまたはファイルパスを指定します。

![RTM作業台](../../../images/items/rtm/rtm-workbench.png)

RTM作業台