この翻訳について
- 翻訳対象 GitHub Flavored Markdown - User Documentation
- とても意訳
- 非エンジニア向け Github 布教用
- 日本人 非エンジニア向け が目的なので、例文や説明を勝手に編集してるところがあります。
GitHub Flavored Markdown
GitHub はサイト内の イシュー, コメント, プルリクエストなどに GitHub Flavored Markdown (GFM) を採用しています。
標準の Markdown とはいくつか大きな違いがあり、機能追加されています。
もしあなたがまだ Markdown に慣れていないのであれば、あらかじめ標準的な Markdown 記法の基本 ( 翻訳 GitHub Help - Markdown Basics )を確認しておいてください。
タスクリストなどの拡張記法について知りたいのであれば、 Writing on GitHub - User Documentation に目を通してください。これらは イシュー, コメント, プルリクエスト, プルリクエストの説明部分などで利用できます。
標準の Markdown との違い
単語内に複数のアンダースコアが書ける
通常、Markdown がアンダースコア (_) をイタリック体として表示するところを、GFM では単語内に複数出現するアンダースコアを以下のように無視します。
- wow_great_stuff
- do_this_and_do_that_and_another_thing.
これにより、アンダースコアを使ったコードや名称を正しく表示することができます。
イタリック体で強調したい場合、アスタリスク (*) を利用してください。
URL の自動リンク
GFM は一般的な URL を自動でリンクに変換します。
URL をリンクとして表示したいならば、ただ URL を入力するだけですみます。Markdown のリンクテキスト記法を用いる必要はありません。
このように書くと、
http://example.com
次のように表示されます。
打ち消し線
GFM では標準の Markdown にはない、打ち消し線の記法が追加されています。
このように書くと、
~~Mistaken text.~~
次のように表示されます。
Mistaken text.
コードブロックの囲み記法
標準の Markdown は、行頭 4 つの半角スペースでインデントした段落を、コードブロックに変換します。
GFM でも同じ記法が利用できますが、次のように ``` でコードを囲むことでも同様の表示になります。 4 スペースでインデントする必要はありません。
4 スペースインデントの記法とは違い、囲み記法の場合は、前の行に改行を入れる必要はありませんが、変換する前の Markdown も読みやすさを保つために改行を入れたほうが良いでしょう。
Here's an example:
```
function test() {
console.log("notice the blank line before this function?");
}
```
注意しなければならない点として、リストの中でコードブロックを正しく表示するには、 囲み記法ではなく 8 スペースでインデントする必要があります。
(以下は翻訳時に勝手に例を補足)
このように書くと、
* list item
code block in list item
code block in list item
次のように表示されます。
-
list item
code block in list item code block in list item
シンタックスハイライト
コードブロックはそのままワンステップ手を加えるだけでシンタックスハイライトに対応します。
コードブロックの囲み記法に言語の識別名となるキーワードを追記すれば、その言語の文法に応じてハイライトが有効になります。
例として Ruby のコードでシンタックスハイライトを有効にするには次のようにします。
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```言語の検出とシンタックスハイライトには linguist を利用しています。
言語の識別名としてどのようなキーワードが利用できるのか知りたい場合、 linguist/languages.yml at master · github/linguist を参照してください。
表 (テーブル)
表を作成するには、テキスト、行の区切りとしてハイフン - (1行目のみ)、列の区切りとしてパイプ | を組み合わせます。
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
みためをより表らしくしたければ、次のように行頭・行末に追加でパイプを足してもかまいません。
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
次のように、列区切り --- の長さは、必ずしも列見出しのテキストの長さとぴったり一致している必要はありません。
| Name | Description |
| ------------- | ----------- |
| Help | Display the help window.|
| Close | Closes a window |
リンク、ボールド、イタリック、打ち消し線といったインラインの Markdown 記法を表の中で利用可能です。
| Name | Description |
| ------------- | ----------- |
| Help | ~~Display the~~ help window.|
| Close | _Closes_ a window |
最後に、見出し行の区切り線にコロン : を含めることにより、テキストの左寄せ、右寄せ、中央寄せを指定することができます。
| Left-Aligned | Center Aligned | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
コロンを左端に書いた場合は、テキスト左寄せの列となり、右端に書けばテキスト右寄せ、両端に書いた場合は中央寄せの列になります。
HTML
README, イシュー、プルリクエストでは HTML のいくつかが利用可能です。
サポートされているタグと属性の全リストが知りたい場合は、 the README for github/markup を参照してください。