チュートリアル

ドキュメントとは異なり、チュートリアルでは、さまざまな Jekyll のトピックやシナリオを網羅する、より詳細で具体的な指示を提供します。チュートリアルには次のような内容が含まれる場合があります。

  • 特定のシナリオまたは課題を順を追って処理する手順
  • サンプルデータを使用して完全な演習を行い、サンプルデータの入力と結果を示します
  • さまざまな Jekyll 戦略の長所と短所に関する詳しい説明
  • Jekyll サイトでの完全な機能を開発するためのエンドツーエンドの指示
  • ドキュメント全体のさまざまなテクニックを組み合わせた手順

つまり、チュートリアルはドキュメント内の主要なリファレンス情報ではありません。ユーザーを最初から最後までプロセス全体を通して案内します。

チュートリアルセクションは新しいものであるため、まだチュートリアルは多くありません。このセクションにチュートリアルを追加して、セクションの充実にご協力ください。

これらのテクニックの中には、Jekyll サイトで使用されるサポートツール、スクリプト、サービス、またはその他のハックをガイドするものもあります。外部サービスを含むチュートリアルを Jekyll に含めることもできます。ただし、Jekyll はチュートリアルで言及されているサードパーティのツールを一切支持していないことに注意してください。

チュートリアルを投稿する方法

チュートリアルの投稿を歓迎します。チュートリアルを追加するには、

  1. jekyll/jekyll プロジェクト GitHub リポジトリの右上隅にある **フォーク** ボタンをクリックして Jekyll プロジェクトをフォークします。
  2. _tutorials コレクションにチュートリアルを追加します。
  3. チュートリアルには、他のチュートリアル項目と同じフロントマター項目があることを確認します。
  4. _data/tutorials.yml でチュートリアルのファイル名への参照を追加します。これにより、チュートリアルがチュートリアルサイドバーに表示されます。
  5. 通常の git ワークフローに従ってプルリクエストを送信します。

プルリクエストを送信すると、Jekyll ドキュメントチームが投稿をレビューし、マージするか編集を提案します。

戻る