ブックマーク / blog.takahash.com (1)

  • GitHub - マークダウン記法でREADMEの可読性を高めよう - たきゃはしです

    2012年6月26日更新 キレイ好き必読!? はい、30分前の私です。 マークダウン記法・・・私の解釈は「普通のテキスト(README)が、ちょっとした決まりで書けば、すごく読みやすい見た目にしてくれる」って感じです。 構文もかなり直感的で、すぐ身につけることが出来ます。(広義的な説明は *1) ま、言葉で説明してもピンとこないので、例を見てみましょう。 例はGitHubに表示されるREADMEとします。 プレーンテキストとマークダウン記法の差 プレーンテキスト メリハリのないテキストが マークダウン記法 読みやすくなる。 基的なマークダウンの書き方 実際に使ったマークダウンを抜粋してまとめます。 ファイル拡張子について 「.md」または「.markdown」 見出し #FastCSV上の例では(h1)になります。 テキストの頭に置いた'#'が見出しのレベルと対応します。 改行 文末に半

    GitHub - マークダウン記法でREADMEの可読性を高めよう - たきゃはしです
  • 1