curriculum-format は0章と1章以降のフォーマットを導入するためのリポジトリです。
まず、教材を執筆するリポジトリ内で以下のコマンドを実行して、Gitサブモジュールを追加してください。
git submodule add git@github.com:Techpit-Market/curriculum-format.git上記のコマンドを実行すると、curriculum-formatというディレクトリがリポジトリに追加されます。
curriculum-format
├── 0章のフォーマット
├── 1章以降のフォーマット.md
├── README.md
└── 簡易手順書のサンプル例.md
これで curriculum-format の導入は完了です。
教材のパートを執筆する前に、0章のフォーマットディレクトリ内の0-1 教材の概要.mdや0-2 環境構築.mdファイルのマークダウンをコピー&ペーストしてカリキュラムを執筆してください。
0章のフォーマットディレクトリの内容はお渡ししたスタイルガイドの4-2 セクション0 (0章) を執筆するの内容を元に作成しています。
教材のパートを執筆する前に、curriculum-formatディレクトリ内の1章以降のフォーマット.mdファイルのマークダウンをコピー&ペーストしてカリキュラムを執筆してください。
1章以降のフォーマット.mdの内容はお渡ししたスタイルガイドの4-3 セクション1以降を執筆するの内容を元に作成しています。
curriculum-format に関して何か不明点や要望がございましたらお気軽にSlackでご連絡ください。よろしくお願いいたします。