Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

GitHub | GitHub Flavored Markdown(GFM)

概要

GitHub Flavored Markdown(GFM)

詳細

GitHubのIssue,Wiki,READMEなどはGitHubが独自拡張したMarkdown形式である
GitHub Flavored Markdown(GFM)がサポートされています。

記法に関する詳細は下記URL参照
https://help.github.com/articles/github-flavored-markdown

標準的なMarkdown記法との違い

undersocored形式の文字への表示

標準ではundersocored形式文字はイタリックで表示されます。
GitHubではソースコードを扱うことが多く、ソースコードでは変数名・メソッド名などで頻繁に
undersocored形式を利用します。
こういった際にイタリック表示されるのは、好ましくないためGFMではイタリックにしません。

リンクテキストの略記

標準ではリンクテキストを利用するには () を利用します。
GFMではURLを記述してあれば、自動的にリンクに変換します。

http://example.com
取り消し線

標準では取り消し線はサポートされていませんが、GFMでは以下の記法をサポートします。

~~some missing~~
コードブロック

標準ではスペース4でコードブロックを表します

code title

    code line1
    code line2
    code line3

GFMでは下記のようにフェンスで囲うことでより見やすく記述することができます。

code title

~~~
code line1
code line2
code line3
~~~

~~~は```でもよい。

シンタックスハイライト

コードブロックに言語名などを指定することでシンタックスハイライトを利用できます

~~~ruby
class RubyClass
  def ruby_method
    "ret"
  end
end
~~~
テーブル

下記の文法でテーブルレイアウトを作成できます。

header1 | header2
------------- | -------------
column1_1  | column1_2
column2_1  | column2_2

見た目を整えるために各行の前後にパイプを追加することもできます。

|header1       | header2      |
|------------- | -------------|
|column1_1     | column1_2    |
|column2_1     | column2_2    |

Align指定も可能です。

|left-align       | right-align      | center-align      |
|:-------------   | -------------:   |:-------------:    |
|column1_1        | column1_2        | column1_2         |
|column2_1        | column2_2        | column2_2         |