2013年4月20日土曜日

GitHub の Readme.md を Wiki を使って書く

GitHub の Readme.md は最初は書き方がよくわかりません。
リポジトリの Wiki で WYSIWYG エディタを使って md 形式の文章が書けるので、
Wiki を使って書いてみます。

リポジトリの Wiki を開きます。


New Page をクリックしてページを作成します。
保存はしないので名前は適当に。



右上の Edit mode が Markdown になっていることを確認します。
h1 や 画像、リンクなどボタンを使って編集します。



画面下の Preview ボタンを押して出来栄えを確認しましょう。

完成したら、エディタ内の文章を Readme.md にコピペすれば OK です。
Wiki のページは破棄して構いません。


ちなみに、プレビューしながら書ける Web サービスやソフトもあるようです。

Github Preview
http://github-preview.herokuapp.com

0 件のコメント:

コメントを投稿