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