README.mdファイル。マークダウン記法まとめ

by codechord.9 Comments

つい先日から、ようやくgithubを使い始めました。
gitのことはあまり勉強してないので右も左もわからず、とりあえず、公開されてるレポジトリのクローンを作りまくってニヤニヤ閲覧しています。

で、そろそろ自分もリポジトリを作りたいなと思って、作り方を調べてたんですが、
「README.md」ファイルというものの存在を知りました。

拡張子「.md」？何の事かさっぱりわからず、ドットモジュールって勝手に思ってたんですけど、全然違いました。「マークダウン」の略でした///

マークダウンとは

マークダウンファイルとは何ぞや。調べました。
普通のテキストファイルを、ちょっとした法則にならって書くだけで、HTMLマークアップせずに、自動的にHTMLコードとして変換して出力してくれるというものでした。
このちょっとした法則がマークダウン記法っていう。

READMEファイルは、このマークダウン記法で書くと、わかりやすいREADMEが作れるよ。ということですが、
要は、READMEを書くときに、読む人にもわかりやすいように構成考えて書こうね。
って事だと思います。

いろんなところで使われてるみたいで、ホント今更知った。
ちなみに、githubでのマークダウン記法はGFM（GitHub Flavored Markdown）と呼ばれてるらしい。

マークダウン記法

さて、それではまとめていきます。
ざっと調べただけなので、不足や間違いがあるかもしれません。

段落

空行をあける

1段落目（空行をはさむ）2段落目

改行

行末に2つのスペースを入れる。

1行目  ←行末に半角スペース2つ2行目

強調

・強調。アスタリスク（*）またはアンダーバー(_)で囲う

*強調* または _強調_

・強い強調。アスタリスク2つ（**）またはアンダーバー2つ(__)で囲う

**強い強調** または __強い強調__

コード表示（等幅フォントで表示）

・インラインのコード。バッククォーテーションで囲う

`$hoge = 1`

・複数行のコード。半角スペースを4つ行頭に

    ←半角スペース4つ　$hoge1 = 1 //1行目    ←半角スペース4つ　$hoge2 = 2 //2行目    ←半角スペース4つ　$hoge3 = 3 //3行目

リスト

行頭にアスタリスク(*)か、番号ピリオド（1. ）

* リスト1* リストリスト1-2* リスト21. 順番つきリスト2. 順番つきリスト3. 順番つきリスト

見出し

行頭の#の個数でH1～H6を表す。

# H1見出し## H2見出し#### H4見出し

または、

H1見出し（イコール行を挿入。）==================H2見出し（ハイフン行を挿入。）---------------------------------

引用（blockquote）

メールの引用の感じ。途中で改行しても、ダブルクォーテーション内は改行されない。入れ子もOK

> "引用本文引用本文引用本文引用本文引用本文引用本文引用本文引用本文引用本文引用本文。"> 引用本文引用本文引用本文引用本文> 引用本文引用本文引用本文引用本文引用本文引用本文。> > 入れ子入れ子> > 入れ子入れ子> 引用本文引用本文引用本文引用本文> * リスト> 引用本文引用本文引用本文引用本文> 1. 番号リスト> 引用本文引用本文引用本文引用本文> $hgoe = 1 コードを書いてみたり> 引用本文引用本文引用本文引用本文

リンク

記法は3種。リンクのタイトルは省略可能。

■自動リンク
アングルブラケット< >でURLを囲う。メアドでも可能

<http://example.com><example@example.com>

■通常のインライン記法

[リンクのテキスト](リンクのアドレス "リンクのタイトル")

■外部参照リンク（段落の外でリンクをまとめれる）

[リンクのテキスト][linkref][linkref]: リンクのアドレス "リンクのタイトル"

・実際の例：

I get 10 times more traffic from [Google][] than from[Yahoo][] or [MSN][].[google]: http://google.com/        "Google"[yahoo]:  http://search.yahoo.com/  "Yahoo Search"[msn]:    http://search.msn.com/    "MSN Search"

画像

先頭にビックリマーク

![Alt text](/path/to/img.jpg)![Alt text](/path/to/img.jpg "Optional title")・リンクと同じように参照表記も可能![Alt text][id][id]: url/to/image  "Optional title attribute"

水平線

3つ以上のハイフン、アスタリスク、アンダースコアをならべる。間にスペースをいれても良い

* * *********- - ----------------------------------------

その他の注意

&マークなどは「&amp;」に変換しておく。

■エスケープしておくべき箇所

エスケープ一覧

\   backslash`   backtick*   asterisk_   underscore{}  curly braces[]  square brackets()  parentheses#   hash mark+   plus sign-   minus sign (hyphen).   dot!   exclamation mark

まとめ

結局のところ、実際に、自分で書いてみないとわかりません。
こちらのページでリアルタイムで反映されるwebエディタがあるので、ちょっと触ってみるだけで、雰囲気がつかめるかと思います。

参考させていただいたサイト

githubに特化したマークダウンは本家を見るべきですね。


9 Responses to README.mdファイル。マークダウン記法まとめ

  1. はじめての Github で自作のライブラリを公開するためのリポジトリ作成や設定まとめ | ウェブルsays:

    […] README.mdファイル。マークダウン記法まとめ | codechord […]

  2. 9ra10 » MarkDownを勉強し始めるsays:

    […]https://codechord.com/2012/01/readme-markdown/http://bamka.info/3765/http://blog.2310.net/archives/6 […]

  3. コーディング規約を作ろう | Webクリエイターボックスsays:

    […] 詳しい説明は「README.mdファイル。マークダウン記法まとめ」がわかりやすかったです。 […]

  4. README.mdファイル。マークダウン記法まとめ | codechord | さとういちろうのへやsays:

    […] 情報源: README.mdファイル。マークダウン記法まとめ | codechord […]

  5. Markdown記法を使ってみる | cly7796.netsays:

    […] README.mdファイル。Markdown記法まとめ | codechord […]

  6. git/githubのお勉強 | よっしーの冒険says:

    […] README.mdの書き方https://codechord.com/2012/01/readme-markdown/ […]

  7. githubになかなかup出来なくてちょっとだけ困った（解決済み） – senotechsays:

    […]https://codechord.com/2012/01/readme-markdown/ […]

  8. マークダウン記法の書き方 – Site-Builder.wikisays:

    […] README.md ファイル。マークダウン記法まとめ | codechord […]

  9. htmlを使うならコーディング規約を設定しよう！says:

    […] 参考：README.mdファイル。マークダウン記法まとめ […]

コメントを残すコメントをキャンセル

メールアドレスが公開されることはありません。* が付いている欄は必須項目です

CAPTCHA


POPULAR ENTRY

RECENT ENTRY

PROJECT

CATEGORY

ARCHIVE

TAG

AddonAPIappstorebuddypresscmsCoda2compassdrupal7Firefoxgitgithubgoogle analyticsiPadiPhonejavascriptjqueryLaravelmacMAMPmustachePHPporeactreportSCMSCSSSublimeText2subversioSubversionsvnsymfonytemplate enginetracVagrantvccwWordMovewordpressお知らせまとめマークダウンローカライズ多言語書評翻訳開発環境