一連のプログラミング チュートリアルといくつかのコードを github で公開したいと考えています。チュートリアルはマークダウンで記述されます。相互に参照するマークダウン ドキュメントがいくつかあります。
今、私は何が最良の選択肢になるのだろうかと思います:
私は github ページや github wiki にあまり詳しくないので、このコンテキストでの (欠点) 利点についてのヒントは役に立ちます!
あなたはこれを行うことができる3つの異なる方法について言及しました.私はそれらのそれぞれについて詳しく説明します...
この方法は、リポジトリをフォークした後にプル リクエストを送信するだけでよいため、Markdown を知っていれば (とにかく Markdown は非常に簡単に習得できます)、貢献することができるため、実際にはそれほど悪い方法ではありません。また、Github はGithub Flavored Markdownと呼ばれるものを使用するため、コードを各ファイルに直接埋め込むことができ、見栄えの良い構文の強調表示を行うことができます。
Github wiki を使用することは、他の人が簡単に貢献できるため、実行可能なオプションです。ただし、承認タイプのシステムで他の人が変更を行うことを好む場合があります。これは、プル リクエスト機能があるため、最初のオプションを使用する場合です。個人的には、ウィキを純粋に使用することはお勧めしません。なぜなら、それは Github リポジトリ自体を弱体化させるからです (ウィキにヒープを持つ空のリポジトリを持つ)。これは私の個人的な意見ですが。
Github Pages generator を使用して、それを使用して Web サイトを作成できます。ただし、Jekyll を使用してサイトを生成し、ジェネレーターが自動的に作成するページは 1 つだけであり、残りのページは Markdown と HTML を使用して作成する必要があることを指摘したいと思います。見栄えは良くなりますが、はるかに時間がかかります。
Markdown で記述された Github リポジトリでチュートリアル自体をホストすることをお勧めします。その後、チュートリアルのすべての部分にリンクするページ ジェネレーターを使用してページを作成できます (ランディング ページとして機能します)。