Frontmatter

Frontmatter

Frontmatterとは、マークダウンファイルの上部にあるデータのことで、破線で挟まれています。

---
id: 1
---
Markdown content

Boxのドキュメントでは以下のFrontmatterがサポートされています。

キー説明
alias_pathsこのページにリダイレクトするパスのリスト。古いURLを新しいURLにスムーズにリダイレクトするために使用します。
centeredコンテンツをページの中央に揃えるために、(ガイドではなく) ページを<Centered>要素にラップします。
hideこのページを検索対象から外します。
hide_in_page_nav右側のページ内ナビゲーションを非表示にします。
hide_step_numberクイックスタートガイドの左側のサイドバーにある手順番号を非表示にします。
hide_titleページのタイトルを非表示にします。ホームページで使用します。
rankページのランク。サイドバーやその他のページリストでページを並べ替える際に使用されます。
related_endpointsこのガイド/ページに関連するエンドポイントID (get_files_idなど) のリスト。これらは、ページ下部で、マークダウンコンテンツの後に表示されます。
related_guidesこのガイド/ページに関連するガイドID (tooling/postmanなど) のリスト。これらは、ページ下部で、マークダウンコンテンツの後に表示されます。
related_pagesこのガイド/ページに関連するページID (sdks-and-toolingなど) のリスト。これらは、ページ下部で、マークダウンコンテンツの後に表示されます。
related_resourcesこのガイド/ページに関連するリソースID (fileなど) のリスト。これらは、ページ下部で、マークダウンコンテンツの後に表示されます。
required_guidesこのガイド/ページの前に読む必要がある前提条件ガイドID (tooling/postmanなど) のリスト。これらは、ページ上部で、タイトルとマークダウンコンテンツの間に表示されます。
typeこれが表すガイド/ページのタイプ (省略可)。現時点で有効な値はquick-startガイドのみです。