107

READMEファイルを更新するときにgithubが使用する軽量マークアップ言語にあまり詳しくありません。

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

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

4

7 に答える 7

127

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

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

そのページからの素晴らしいヒント：

チートシートを表示するには、Markdownエディターを使用してGithubページでMを押します。

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

アップデート2012-11-08：Markdown構文を標準化するための取り組みが進行中です。マークダウンの未来-ジェフアトウッド、コーディングホラーおよびW3Cマークダウンコミュニティグループを参照してください。

アップデート2014-09-09： CommonMarkのマークダウン標準と仕様がリリースされました。

于 2012-04-20T04:10:30.237 に答える
11

（いくつかの編集を加えて、この回答を再投稿してください。）

ゲームに少し遅れましたが、Pythonで小さなCLIを作成しました。これはGrip（Github Readme Instant Preview）と呼ばれます。パトリックの答えに加えて、これにより「私のブラウザでローカルに私のドキュメントをレビューする」ことができます。

次のコマンドでインストールします。

$ 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
  • リンクされたファイル間を移動する
  • レンダリングされたドキュメントをファイルにエクスポートする

お役に立てれば。それをチェックしてください。

于 2014-07-21T04:04:15.383 に答える
5

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

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

GitHubにもPreviewボタンがあります。

次のスクリーンショットで、[編集]をクリックしたときにこのボタンが表示されることを確認してREADME.mdください。

ここに画像の説明を入力してください

IMHOのライブエディターは、GitHubで利用可能な現在のエディターよりも優れています。

アップデート

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

それは持っています：

  • 構文の強調表示=>Markdown構文のフルカラー化
  • 組み込み言語用のIntellisense（W00T）=> GitHubの組み込み言語機能は、```言語構文のサポートによって完全にサポートされています。

ここに画像の説明を入力してください

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

詳細はこちら。

于 2014-05-21T00:23:28.500 に答える
4

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

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

https://f.cloud.github.com/assets/17715/1999080/7f0c15a2-853e-11e3-95dc-1d7737e1ec20.png

テキスト以外の変更は、控えめな点線の下線で表示されます。テキストにカーソルを合わせると、何が変わったかがわかります。

https://f.cloud.github.com/assets/17715/2005588/714cb5ea-86ef-11e3-9e92-a0d11ba6084f.png

于 2014-02-15T10:56:55.460 に答える
1

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

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

于 2014-04-28T10:32:32.170 に答える
1

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

ここに画像の説明を入力してください

于 2017-02-07T11:23:09.763 に答える
0

他のツールが十分に優れているとは思いませんでした-私は欲しかった：

  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が使用されるため、驚くことはありません。

于 2014-02-18T00:58:49.063 に答える