[解決済み] github.comのREADME.mdとの連携 [終了しました］

質問

READMEファイルを更新する際にgithubで使われている軽量マークアップ言語にはあまり詳しくないのですが、どうすればいいのでしょうか？

オープンソースライブラリのREADME/wikiファイルに適切なマークアップ構文を記述する方法について読み取ることができるリソースはどこにありますか？

そして、更新されたREADMEを私のgithubリポジトリにプッシュする前に、ブラウザでローカルに私のドキュメントをレビューすることができるツールはありますか？

どのように解決するのですか？

問題のマークアップは、偶然にも マークダウン の著者であるJohn Gruberによって作成されました。 Daring Fireballブログ . Markdownのオリジナルのソースは次のサイトで見ることができます Daring Fireball - Markdown .

Markdownには多くの方言があり、Githubのドキュメントは Githubフレーバーマークダウン ページで見ることができます。

そのページからの素敵なヒント。

プレス M を押すと、チートシートが表示されます。

また Github Markdownライブプレビュー ページであなたのMarkdownドキュメントをテストすることができます。

2012-11-08更新 : Markdownの構文を標準化するための取り組みが行われています。 参照 Markdownの未来 - Jeff Atwood, Coding Horror そして W3C Markdownコミュニティ・グループ .

2014-09-09 更新 : コモンマーク マークダウンの標準と仕様が発表されました。