Githubの「マークダウン形式の」READMEファイルとは何ですか?


27

そのフォーマットが何であるか、それを作成するための体系的/コマンドライン要件があるかどうかなど、私にはわかりません

基本的に、仕様を知る必要がある場合、およびREADMEファイルを生成するための技術的な手順がある場合。


4
いいえ、手動で編集するテキストファイルだけです。構文については、en.wikipedia.org / wiki / Markdown
アンドレア

3
この側が使用するのと同じwiki編集形式。
k3b

+1 @Andrea:ありがとう、私はほんの一握りのマークダウン形式を考えることができますが、Githubでどの形式とバージョンが期待されていますか?また、あなたはコメントをより多くの回答として読みます。完全な回答として投稿してください。繰り返しますが、ありがとう!
失策

+1 @ K3b:何かに取り組んでいると思いますが、GithubでのGollumの使用について話していますか?もしそうなら、これを答えとして投稿してください。それが正しい答えだと思います。ありがとう!
失策

回答:


37

Markdownは、セマンティック情報を提供し、一般的な書式設定をプレーンテキストで表すための単純な構文です。Daring Fireballには、標準のマークダウン用のすばらしい構文ガイドがあります。GitHubは、GitHub Flavored Markdownと呼ばれるこのバリアントを使用します。

READMEをセットアップするには、プレーンテキストファイルを作成してREADME(またはREADME.md / README.markdown)という名前を付け、リポジトリのルートにコミットします。GitHubは、プロジェクトのreadmeとしてこれを選択します。


2
また、Markdownの使用方法を説明するビデオも作成しました。ここで見つけることができます:mikemclin.net/markdown-syntax-language
Mike McLin

9

Wikipedia — Markdownは、「GitHub Flavored Markdown-Introduction」archv。)ページを参照します

ページから引用:

GitHubは、メッセージ、問題、コメントに「GitHub Flavored Markdown」(GFM)と呼んでいるものを使用します。いくつかの重要な点で標準のマークダウン(SM)とは異なり、いくつかの追加機能が追加されています。

このページには、標準のマークダウンとの違いの説明も記載されています。

GitHubによってMarkdownが実際にレンダリングされる方法に関する詳細情報もあります。

Markdownファイルのレンダリング方法に興味がある場合は、SundownライブラリへのRubyインターフェイスであるRedcarpetをチェックしてください。

(どうやら、Sundownはカーテンの後ろで使用される実際のMarkdownパーサーです。)

抽象化のレイヤーをもう1つ追加するために、Sundownはさらに別のMarkdownパーサーのフォークです:-) SundownのGitHubページ
からの引用:

Sundownは、NatachaPortéによるUpskirtライブラリの元のコードに基づくマークダウンパーサーです。


1

非常に奇妙ですが、GitHubはREADMEファイルをレンダリングするときにGitHub-Flavoured Markdown(GFM)を使用しいないように見えます。

GitHubは、サイト全体で「GitHub Flavored Markdown」またはGFMを使用します。これには、問題、コメント、プルリクエストが含まれます。

代わりに、GitHubマークアッププロジェクトの一部としてredcarpetと呼ばれるバージョンを使用しているようです。また、MediaWikiなど、他のいくつかのマークアップ形式もサポートしています。適切なファイル拡張子を使用するだけで、GitHubはマークアップをレンダリングします。

Markdownの2つの異なるフレーバーの違いを確認したい場合は、GFMその追加機能の説明をお読みください。


1
redcarpetとGithub Flavored Markdownは2つの別個の、しかし補完的な概念であり、同じものの競合する実装ではありません。redcarpetは基本的に、Github Flavored Markdown 言語で記述されたものを受け取り、HTMLまたはXHTMLを出力するコンパイラーです。
8ビットツリー
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.