ドキュメントの追加・書き方
ページの追加方法
Jekyllを利用してページの自動生成を行っています。
開発ドキュメントのソースコードにある _pages ディレクトリの中にmarkdownファイル(.md)を置くと、自動的にページが追加されます。
markdownヘッダー部分の書き方
ページ生成時に利用するヘッダー情報です。各ページに必ず記載する必要があります。
---
title: テストページ
description: xxxxを行う場合のツール導入方法と実装についてのポイントをまとめました。
permalink: test
tags: [quickstart, install]
---
title ：h1タグのコンテンツになります。
description ：シェアした場合に og:description になります。
permalink ：ページのURLになります。hoge/testのような書き方も可能。
tags ：タグ付けができます。
左のメニューに追加する場合
_data/navigation.yml に追加して下さい。小カテゴリの階層は第２階層まで作ることができます。
docs:
- title: 大カテゴリ
output: web, pdf
children:
- title: コンテンツ
url: /quickstart_requirement
output: web, pdf
- title: 小カテゴリ
output: web, pdf
sub_items:
- title: コンテンツ
url: /update
output: web, pdf
ページの書き方
- markdownで記載して下さい。
- 改行(brタグ)は行末に改行２つ必要です。
- 外部へのハイパーリンクの場合は
{:target="_blank"}を記述してください。 - 「```php」と書くことでシンタックスハイライトを指定することができます。
- テンプレートで用意されているUtility/Helpersを利用することができます。
Utilityサンプル
補足情報などを囲って読みやすくすることができます。