タグ

関連タグで絞り込む (1)

タグの絞り込みを解除

github markdownに関するbleu-bleutのブックマーク (3)

  • 脱GitHub初心者を目指す人のREADMEマークダウン使いこなし術 | ゆっくりと…

    README がキチッと書かれているプロジェクトって、どんなに小さくても立派に見えますよネ。 GitHub の場合、大抵はマークダウン記法で書かれた README.md とか README.markdown とかいう名前のファイルが、HTML に変換 (マークアップ) されて表示されていることはご存知でしょう。 マークダウン記法自体はとても簡単なのですが、GitHub では GitHub Flavored Markdown (略して GFM) という GitHub 用にアレンジされたマークダウン・エンジンが採用されていて、一般のマークダウン・エディタでチェックしてからコミットしても、意図通りの見た目にならないことが多々あります。私 (もちろん GitHub 初心者です!) の場合、README ファイルだけで10回以上もコミットしてしまいました。「マークアップ (レンダリング) を気にして

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

    Posted 1月 21st, 2012 by codechord. 9 Comments Tweet Tweet つい先日から、ようやくgithubを使い始めました。 gitのことはあまり勉強してないので右も左もわからず、とりあえず、公開されてるレポジトリのクローンを作りまくってニヤニヤ閲覧しています。 で、そろそろ自分もリポジトリを作りたいなと思って、作り方を調べてたんですが、 「README.md」ファイルというものの存在を知りました。 拡張子「.md」?何の事かさっぱりわからず、ドットモジュールって勝手に思ってたんですけど、全然違いました。「マークダウン」の略でした/// マークダウンとは マークダウンファイルとは何ぞや。調べました。 普通のテキストファイルを、ちょっとした法則にならって書くだけで、HTMLマークアップせずに、自動的にHTMLコードとして変換して出力してくれるという

    README.mdファイル。マークダウン記法まとめ | codechord
  • GitHub - マークダウン記法でREADMEの可読性を高めよう - たきゃはしです

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

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