Markdown記法主要メモ

READMEの為のMarkdown記法

見出し

先頭の「＃」の数を1-6の間で選び、大きさを決める。数が増えるほど、見出しは小さくなる。

改行

スペース2つを文末に入れる。

文字の装飾

*「*」、もしくは「__」で囲うとイタリック体
＜em＞になる。
「 **」「__ __」は太字。

• 3つになるとイタリック体太字。
• 「~~ ~~」は打ち消し線。
• [" と "] はメニューボタンの外観。
• [’ と ’] はキーボードのキーの外観。

リスト

先頭に「*」で箇条書きリスト。(+、-も可)
数字 ＋ 「.」でナンバリングリスト。
半角スペース2つ以上字下げで、入れ子に出来る。

チェックボックス

リストの記法に[x]もしくは[ ]でタスクの表示。
[x]は完了、[ ]は未完。

定義

• 2行目先頭「:」＋ 1つ以上のスペースで、 1行目の内容を定義するリスト表示。1行目に下記を付与で、
  • {.note} ・・・ メモ
  • {.tip} ・・・ ヒント
  • {.info} ・・・ 情報
  • {.warning} ・・・ 注意
  • {.caution} ・・・ 警告
    を付箋形式に。付箋が連続する場合は、

で区切る。1行目は省略可。

リンク

• 先頭に[テキスト]: (URL)でリンク表示。
• 上の文末に{target="_blank"}で、 リンク先を新しいタブで開く。
• <>か[]で囲むとリンクのみの表示。 メールは<>のみ対応。

画像

リンクの記述の先頭に「!」で画像。
左右に寄せたい場合は、スペース ＋ {.left} など。影付けはスペースなし{.dropshadow}

テーブル

|-----|:-----|
「：」で文字の寄せる方を決める。

引用

先頭が「＞」。入れ子可。