Mastering-markdown-jp¶

訳にあたって¶

翻訳元：https://guides.github.com/features/mastering-markdown/
結構端折ってます。

Markdown は軽くて簡単に使える言語です。GitHubプラットフォームで文章を記述するために使用できます。

何が身につくか

• どのようにMarkdownを利用するか
• Markdownはこれまでのものとどう違うか。
• GitHubのMarkdown自動レンダリングの活用
• GitHubの独自拡張をどう利用するか

Markdownってなに？¶

MarkdownはWebで文章を書くための方法です。ドキュメントの表示を取り扱います。
つまり、太字や斜体、画像の追加、リストの作成を簡単に行えます。
#や*を除き、Markdownはほとんど文章そのままです。

GitHubの多くの場所でMarkdownを使うことができます。

• Gists
• イシュー、プルリクエストのコメント
• .md、.markdown形式のファイル

もっと知りたい場合は、GitHubヘルプ内の「GitHubで書く」をご覧ください。

例¶

テキスト¶

It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com)

It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!

リスト¶

Sometimes you want numbered lists:

1. One
2. Two
3. Three

Sometimes you want bullet points:

* Start a line with a star
* Profit!

Alternatively,

- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this

Sometimes you want numbered lists:

1. One
2. Two
3. Three

Sometimes you want bullet points:

• Start a line with a star
• Profit!

Alternatively,

• Dashes work just as well
• And if you have sub points, put two spaces before the dash or star:
• Like this
• And this

画像¶

If you want to embed images, this is how you do it:

![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

If you want to embed images, this is how you do it:

見出しと引用¶

# Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.

### This is a third-tier heading

You can use one `#` all the way up to `######` six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
> - Captain Janeway

Structured documents¶

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.

This is a third-tier heading¶

You can use one # all the way up to ###### six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

Coffee. The finest organic suspension ever devised... I beat the Borg with it.
- Captain Janeway

コード¶

preタグが邪魔なのでうまく書けぬ…

追加機能¶

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!

But I have to admit, tasks lists are my favorite:

- [x] This is a complete item
- [ ] This is an incomplete item

When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!

And, of course emoji!

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!

But I have to admit, tasks lists are my favorite:

• [x] This is a complete item
• [ ] This is an incomplete item

When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!

And, of course emoji!

文法ガイド¶

この章では、Markdown文法についての概要です。これらはGitHub.comやテキストファイルで使用できます。

見出し（Headers）¶

# これは<h1>タグになります
## これは<h2>タグになります
####### これは<h6>タグです

強調（Emphasis）¶

*このテキストは斜体になります*
_このテキストも斜体になります_

**これは太字になります**
__これも太字になります__


_これらを **あわせて** 使うこともできます_

リスト（Lists）¶

順序なし¶

* 項目 1
* 項目 2
    * 項目 2a
    * 項目 2b

順序あり¶

1. 項目 1
1. 項目2
1. 項目 3
    1. 項目 3a
    1. 項目 3b

画像（Images）¶

![GitHubロゴ](/images/logo.png)
形式: ![Alt Text](url

リンク（Links）¶

http://github.com - 自動でリンクされます！
[GitHub](http://github.com)

引用（Blockquotes）¶

カニエ・ウェストは言った：

> 我々は未来を生きている。
> 今とは過去なのだ。

インラインコード（Inline code）¶

代わりにここは
`<addr>`要素を使うべきだと考えている

GitHub式Markdown（GitHub Flavored Markdown）¶

GitHub.comはいくつか便利な機能を追加したバージョンのMwarkdownを使用しています。
これらはGitHubでの活動をより簡単にします。

GitHub式Markdownの機能のいくつかは概要（descriptions）とイシューやプルリクエストでのコメント（comments of Issues and Pull Requests）だけで使うことができます。これらは
これらはSHA1ハッシュ、イシュー、プルリクエストへの参照、@mentionsを含みます。
タスクリストはGistコメント、Gist Markdownファイルでも使用可能です。
TODO なんかここ訳がイマイチ

シンタックスハイライト¶

タスクリスト¶

表¶

最初の行とそれ以外の行を-(ハイフン）で区切ります。これは最初の行のためにです。
各列は|（パイプ）で区切ります

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

これは以下のようになります。

First Header	Second Header
Content from cell 1	Content from cell 2
Content in the first column	Content in the second column

SHA参照¶

コミットハッシュへの参照は自動的にGitHub上のコミットへのリンクとなります。

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

リポジトリのイシュー参照¶

イシューやプルリクエストを参照する数字は自動でリンクになります

#1
mojombo#1
mojombo/github-flavored-markdown#1

ユーザー名の@メンション¶

@に続けてユーザー名を入力すること、その人へコミットを見るように通知を送れます。これを"@メンション"と呼ばれます。
何故ならこれは個別に述べる（mentioning）ことだからです。@メンションは組織のチームにも行えます。

URLの自動リンク¶

URL（http://www.github.com/のような）は自動でリンクになります。

取り消し線¶

二つのチルダで囲む（~~このように~~）ことで取り消し線になります。

絵文字¶

GitHubは絵文字をサポートします。

サポートしてる絵文字の画像はEmoji Cheat Sheetを見てください。