Markdownは、GitHubプラットフォーム上のすべての形式の書き込みをスタイリングするための軽量で使いやすい構文です。
あなたが学ぶこと:
- Markdownフォーマットがスタイル付きの共同編集を簡単にする方法
- Markdownを従来のフォーマットアプローチとどのように異なるか
- Markdownを使用してテキストをフォーマットする方法
- GitHubの自動Markdownレンダリングを活用する方法
- GitHubのユニークなMarkdown拡張を適用する方法
Markdownとは何ですか?
Markdownは、ウェブ上のテキストのスタイルを設定する方法です。, 単語を太字または斜体として書式設定したり、画像を追加したり、リストを作成したりすることは、Markdownでできることのほんの一部です。 ほとんどの場合、Markdownは、#
や*
ように、いくつかの非アルファベット文字がスローされた通常のテキストです。,
Githubのほとんどの場所でMarkdownを使用できます:
- Gists
- 課題とプルリクエストのコメント
.md
または.markdown
拡張
詳細については、GitHubヘルプの”GitHubでの書き込み”を参照してください。
例
- テキスト
- リスト
- 画像
- ヘッダー&引用符
- コード
- エクストラ
構文ガイド
ここでは、どこでも使用できるMarkdown構文の概要GitHub.com または独自のテキストファイルで。,3>Headers
# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag
Emphasis
*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_
Lists
Unordered
* Item 1* Item 2 * Item 2a * Item 2b
Ordered
1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b
Images
!(/images/logo.png)Format: !(url)
Links
http://github.com - automatic!(http://github.com)
Blockquotes
As Kanye West said:> We're living the future so> the present is our past.
Inline code
I think you should use an`<addr>` element here instead.
GitHub Flavored Markdown
GitHub.,comは独自のバージョンのMarkdown構文を使用しており、その多くは便利な機能の追加セットを提供しており、その多くはコンテンツを簡単に操作できますGitHub.com.
GitHub Flavored Markdownの一部の機能は、課題とプルリクエストの説明とコメントでのみ使用できることに注意してください。 これらには、@メンションだけでなく、SHA-1ハッシュ、課題、およびプル要求への参照が含まれます。 タスクリストは、GistコメントおよびGist Markdownファイルでも使用できます。,
構文ハイライト
GitHub Flavored Markdownで構文ハイライトを使用する方法の例を次に示します。
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
コードを四つのスペースでインデントすることもできます。
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
ここ構文ハイライトのないpythonコードの例です。
def foo(): if not bar: return True
タスクリスト
課題の最初のコメントにタスクリストを含めると、課題リストに便利な進捗インジケータが表示されます。 また、プル要求で動作します!,各列をパイプでパレートする|
:
は次のようになります。
最初のヘッダー | 二番目のヘッダー |
---|---|
セル1からのコンテンツ | セル2からのコンテンツ |
最初の列のコンテンツ | 第二の列のコンテンツ |
shaリファレンス
コミットのsha-1ハッシュは、github上のそのコミットへのリンクに自動的に変換されます。,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
リポジトリ内の課題の参照
課題またはプルリクエストを参照する任意の数は、自動的にリンクに変換されます。
#1mojombo#1mojombo/github-flavored-markdown#1
Username@mentions
@
シンボルを入力し、ユーザー名を入力すると、そのユーザーにコメントを表示するように通知されます。 あなたが個人に言及しているので、これは”@mention”と呼ばれます。 組織内のチームを@メンションすることもできます。,
Urlの自動リンク
任意のURL(など)は自動的にクリック可能なリンクに変換されます。
取り消し線
二つのチルダで囲まれた単語(~~this~~
のように)は、交差して表示されます。
Emoji
GitHubは絵文字をサポートしています!
サポートしているすべての画像のリストを表示するには、絵文字チートシートをチェックしてください。
最終更新Jan15,2014