Markdown記法覚え書き

Markdown記法の練習と覚え書き

Markdown記法

基本事項

  1. 段落はひとつの連続したテキスト
    TeXのように空行で分けられます
  2. 改行をする際は行末にスペースを2つ挿入します
    テキスト1(スペース)(スペース)
    テキスト2

記号の使い方

  • バックスラッシュ
    この記法で必要な記号をそのまま表示したい場合
    バックスラッシュでエスケープできます
    (例) \#
  • #:見出し
    #を重ねることで見出しのレベルを変更可能
    (例) # タイトル,## サブタイトル
  • *:斜体
    *で文字を囲むと斜体
    (例) *テキスト*
  • ** :強調
    **で文字を囲むと強調
    (例) **テキスト**
  • *, +, -:箇条書き(記号の直後にスペース or タブ)
    • 3つのどの記号でも使える
    • 混ざってても使えるみたい
    • 記号の代わりに「数字+ "."」とすれば数字のインデックスが付く
      • 順序付きになる
    • インデントレベルを変える場合は記号の前にスペースを4つ挿入
      • 3つ目まで確認
  • >:引用

    ここは引用です

    (例) > テキスト
    引用後のテキストのインデントが変わってしまったと思ったけど
    引用後の行頭にスペース4つでインデントが正しく表示されます

  • [表示するテキスト](URL):リンク
    URLを記載するだけでもリンク貼られるけど
    URLに説明を加えたい場合などに使用
    Markdown記法の参考ページ

  • ![代替テキスト](画像のURL):画像
    上記のリンクと似た使い方
    URLの画像を表示してくれます イメージ
    画像でかかった

コードの記述方法

行頭にスペースを4つ挿入することでコードブロックが作れます インデントが続く限りコードブロックのままです
Markdown記法は無視されます

int foo() {  
    int i = 0;  
    i = i + 1;  
    return i;  
}

また,一行の場合はバッククオートで囲む (例) `printf()` → printf()
等幅フォントになります

バッククオートを3つ使うことで複数行のコードをインラインに書けます
また,ソースコードをハイライト表示したい場合は
バッククオート3つの後に対応する言語を記述します

 ```java
 int foo() {
     int i = 0;
     i = i + 1;
     return i;
 }  
 ```

とすれば,

int foo() {
    int i = 0;
    i = i + 1;
    return i;
}

とりあえずこんなところ.