そのフォーマットが何であるか、それを作成するための体系的/コマンドライン要件があるかどうかなど、私にはわかりません
基本的に、仕様を知る必要がある場合、およびREADMEファイルを生成するための技術的な手順がある場合。
そのフォーマットが何であるか、それを作成するための体系的/コマンドライン要件があるかどうかなど、私にはわかりません
基本的に、仕様を知る必要がある場合、およびREADMEファイルを生成するための技術的な手順がある場合。
回答:
Markdownは、セマンティック情報を提供し、一般的な書式設定をプレーンテキストで表すための単純な構文です。Daring Fireballには、標準のマークダウン用のすばらしい構文ガイドがあります。GitHubは、GitHub Flavored Markdownと呼ばれるこのバリアントを使用します。
READMEをセットアップするには、プレーンテキストファイルを作成してREADME(またはREADME.md / README.markdown)という名前を付け、リポジトリのルートにコミットします。GitHubは、プロジェクトのreadmeとしてこれを選択します。
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ライブラリの元のコードに基づくマークダウンパーサーです。
非常に奇妙ですが、GitHubはREADMEファイルをレンダリングするときにGitHub-Flavoured Markdown(GFM)を使用していないように見えます。
GitHubは、サイト全体で「GitHub Flavored Markdown」またはGFMを使用します。これには、問題、コメント、プルリクエストが含まれます。
代わりに、GitHubマークアッププロジェクトの一部としてredcarpetと呼ばれるバージョンを使用しているようです。また、MediaWikiなど、他のいくつかのマークアップ形式もサポートしています。適切なファイル拡張子を使用するだけで、GitHubはマークアップをレンダリングします。