読者です 読者をやめる 読者になる 読者になる

tyoshikawa1106のブログ

- Force.com Developer Blog -

GitHubで使える便利なREADME.mdファイルの作り方

README.mdファイルとはマークダウンファイルのことらしいです。これを作成すると次のようにコードの説明について記載したり、画像を表示したりといったことが可能になります。

f:id:tyoshikawa1106:20131128004859p:plain


README.mdファイルを使えば、どんな機能なのかわかりやすく説明できるのですごく便利だと思います。このファイルは「Add a README」ボタンから作成できます。

f:id:tyoshikawa1106:20131128005510p:plain


ボタンをクリックするとエディタが表示されるので、表示したい情報を入力します。

f:id:tyoshikawa1106:20131128005935p:plain


入力後は画面下の方にある「Commit New File」ボタンをクリックするとREADME.mdファイルが作成されます。

f:id:tyoshikawa1106:20131128010030p:plain


ファイルが作成されると次のように入力した情報が表示されるようになります。

f:id:tyoshikawa1106:20131128010151p:plain


マークダウンファイルのことをHTMLを表示できるファイルだと勘違いしていたのでHTMLタグで改行したりしていたのですが、本来はHTMLタグを使わなくても決められた記法を使うことで自動でHTMLコードに変換してくれるファイルみたいです。マークダウンファイルで使用する記法をマークダウン記法というみたいです。


マークダウン記法についてはこちらのサイトが参考になりました。

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