命名規則
目次
命名規則
本サイトではlower_snakeに基づいてファイル名を命名しています。
章
一番大きいくくりです。章ごとにindex.md
を作成してください。これが章全体の説明になります。
コンテンツはcontents
フォルダの中で、画像はimgs
フォルダの中で管理してください。
contentsの中に記事を書くときに
- サブフォルダを含まない場合
コンテンツ番号_名前.md
というファイルを作成してください。 - サブフォルダを含む場合
コンテンツ番号_名前
というフォルダを作成し、その中にindex.mdを作成してください。 コンテンツはコンテンツ番号_名前
としてください。
また、
階層構造
できるだけ階層は2層以下にとどめてください。
サブフォルダについて、最後となるフォルダにはcontentsを作成する必要はありません。サブフォルダの中にすべてのコンテンツとimgsフォルダをそのまま置いてください。
画像の命名則
必ずコンテンツ番号_画像名
としてください。
サブフォルダの場合は、サブフォルダ直下にimgs
フォルダを再度作成してください
その他気を付けること
ページ遷移について、.mdをurlとして指定するとうまくいきません。(jekyllによってhtmlに変換されるため)。拡張子を書かずにpathを指定しましょう。