github.com上のREADME.mdの操作[終了]

READMEファイルを更新するときにgithubが使用する軽量のマークアップ言語に精通していません。

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

また、更新されたREADMEをgithubリポジトリにプッシュする前に、「ブラウザーでドキュメントをローカルで確認」できるツールはありますか？

問題のマークアップは、偶然にもMarkdownと呼ばれ、Daring Fireballブログの作者であるJohn Gruberによって作成されました。Markdownの元のソースは、Daring Fireball-Markdownにあります。

多くのMarkdown方言があり、GithubのドキュメントはGithub Flavored Markdownページにあります。

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

MarkdownエディターでGithubページのMを押すと、チートシートが表示されます。

Github Markdown Live Previewページを使用して、Markdownドキュメントをテストすることもできます。

アップデート2012-11-08：Markdown構文を標準化するための取り組みが進行中です。Markdownの未来-Jeff Atwood、Coding Horror、W3C Markdown Community Groupを参照してください。

アップデート2014-09-09： マークダウン標準および仕様であるCommonMarkがリリースされました。

（この回答を編集して再投稿します。）

ゲームには少し遅れましたが、Pythonで小さなCLIを書きました。これはGrip（Github Readme Instant Preview）と呼ばれています。これにより、Patrickの答えに加えて、「自分のドキュメントをブラウザーでローカルに確認」できます。

それをインストールします：

$ pip install grip

そしてそれを使用するには、単に：

$ grip

次ににアクセスlocalhost:5000してreadme.md、その場所にあるファイルを表示します。

独自のファイルを指定することもできます。

$ grip CHANGES.md

そしてポートを変更します：

$ grip 8080

または、前の2つを組み合わせます。

$ grip CHANGES.md 8080

GitHub-Flavored Markdown（つまり、コメントと問題のレンダリング方法）をレンダリングすることもできます。オプションで、他の問題への参照を自動ハイパーリンクするレポコンテキストを使用できます。

$ grip --gfm --context=username/repo issue.md

簡潔にするために、CLIヘルプを使用して、残りのオプションとその詳細を参照してください。

$ grip -h

注目すべき機能：

• GitHubとまったく同じようにページをレンダリングします
• フェンスで囲まれたブロック
• Python API
• リンクされたファイル間を移動する
• レンダリングされたドキュメントをファイルにエクスポートする

お役に立てれば。ご覧ください。

ここに素晴らしいオンライン/ライブエディターがあります：

http://jbt.github.io/markdown-editor/

PreviewGitHubにはボタンもあります。

次のスクリーンショットを見ると、[編集]をクリックしたときにこのボタンが表示されることがわかりますREADME.md。

IMHOライブエディターは、GitHubで入手できる現在のエディターよりも優れています。

更新

MarkdownVisual Studioを検索したところ、VSを使用している場合は、Web Essentialsをインストールして、MarkdownVisual Studio内から直接サポートできることがわかりました。カッコいい！

それは：

• 構文の強調表示=> Markdown構文の完全な色付け
• 組み込み言語向けIntellisense（W00T）=> GitHubの組み込み言語機能は、 `` `言語構文のサポートにより完全にサポートされます。

• プレビューウィンドウ=>レンダリングされたHTMLの並べてプレビューウィンドウを表示する
• HTMLにコンパイル=> Markdownファイルを右クリックし、[Markdown to HTMLをコンパイル]を選択します。これにより、Markdownファイルの下にネストされた.htmlファイルが生成され、Markdownファイルが変更されても同期が維持されます。
• カスタムスタイルシート=>ソリューション固有のスタイルシートを追加して、プレビューウィンドウのスタイルを制御できます。

詳細はこちら。

2014年2月以降、「レンダリングされた散文の差分」を使用すると、マークダウンファイルで差分のレンダリングバージョンを確認することもできます。

散文ファイルを含むコミットとプルリクエストは、ソースビューとレンダリングビューを備えています。

テキスト以外の変更は、低いキーの点線の下線付きで表示されます。テキストにカーソルを合わせると、変更点が表示されます。

別のオプション-Githubの新しいテキストエディターであるAtomは、編集時にgithub風味のマークダウンをレンダリングします。https://atom.io/を参照してください

長期的には（ビールのように）無料になるかどうかはわかりません。

今日から、ファイルを編集しながらプレビューできます。

他のツールが十分であるとは思いませんでした。

1. オフラインで編集する機能
2. 通常のマークダウンだけでなく、実際のGithubフレーバーマークダウン

これは私が最終的に解決したものです：https : //github.com/ypocat/gfms

> gfms

Github Flavored Markdown Server.
Run in your project's root directory.
Usage: gfms

Options:
  -p, --port              Port number to listen at.        [required]
  -h, --host              Host address to bind to.         [default: "localhost"]
  --proxy                 if behind a proxy, proxy url.
  -a, --api               Render using Github API.
  -n, --no-api-on-reload  Disable usage of Github API when the doc is manually reloaded.

だから私はエイリアスしました：

alias gm='gfms -a -p 8070'

この-pオプションを使用すると、Github APIにアクセスし、実際の現在のGithub CSSを使用するため、驚くことはありません。