Markdown の書き方

章立て

  • 行の先頭に # をつける。
  • # の後ろには必ず半角スペースを入れる。
  • # の数を増やすと、小見出しになる。
  • # は 6 個まで。
## 中見出し

文字装飾

イタリック体

  • _ もしくは * で囲む (例 : ここがそう)
  • _, * と単語の間にスペースを入れてはいけない

太字

  • __ もしくは ** で囲む (例 : ここがそう)
  • __, ** と単語の間にスペースを入れてはいけない

打ち消し線

  • ~~ で囲む (例 : ここがそう)
  • ~~ と単語の間にスペースを入れてはいけない

リスト

番号なしリスト (Disc型)

* 項目
* 項目
* 項目
  • 行頭に *, +, _ を書き、直後に半角スペースを入れる
  • リストの全体の前後には空行が必用

番号付きリスト (Decimal型)

1. 項目 1
2. 項目 2
3. 項目 3
  • 行頭に 1. を書き、直後に半角スペースを入れる
  • リスト全体の前後には空行が必要
  • 数字は全て 1 にしても勝手に増えていく

リストの入れ子

  • リストの先頭にインデントを入れれば、リストを入れ子にできる
    • こんな感じ
  • リストの各項目の間に空行を入れてると別のブロックになる
* 項目
    * 項目
        1. 項目 1

リンク

[ここ](http://www.miharu.co.jp/) をクリック
  • [] で囲った部分が表示され、そこに () で指定した URL のリンクが貼られる
  • リンクは相対パスでも絶対パスでも良い

表

| タイトル | タイトル   | タイトル  |
|:---------|:---------:|---------:|
| 左寄せ   | 中央ぞろえ | 右寄せ    |
タイトル タイトル タイトル
左寄せ 中央ぞろえ 右寄せ

引用

水平線

  • -, *, _ を三つ以上並べる
---

***

___

特殊文字

絵文字

  • ここ にあるような絵文字が使えます

コードの挿入

インラインコード

  • 文章中に含まれるコード a = b; は ` (バッククォート、日本語キーだと Shift + @) で囲む
  • インラインコード中に n 回連続の ` を含めたい場合は、 n + 1 回の ` で囲む
  • `のみの場合には前後に空白を入れる

ブロックコード

  • バッククォート 3 つのみで出来た行で囲む
  • バッククォート行の前後には空行が必用
  • 最初の ``` の直後に言語コードを入れれば指定した言語としてシンタックスハイライトが効く
  • GitHub ではファイル名が入らない？
===== 空行 =====
```csharp  
public class Class  
{  
}  
```　
===== 空行 =====

public class Class
{
}

言語

言語 言語コード 拡張子
Makefile make, makefile, mf, bsdmake *.mak, .mk, Makefile, makefile, Makefile., GNUmakefile
C c *.c, *.h, *.idc
CMake cmake *.cmake, CMakeLists.txt
C++ cpp, c++ *.cpp, *.hpp, *.c++, *.h++, *.cc, *.hh, *.cxx, *.hxx, *.C, *.H, *.cp, *.CPP
C# csharp, C# *.cs
VB.net vb.net, vbnet *.vb, *.bas
verilog verilog, v *.v
vhdl vhdl *.vhdl, *.vhd
Scala scala *.scala
Haskell haskell, hs *.hs

参考資料