Skip to content
Nana Sakisaka edited this page Nov 3, 2017 · 5 revisions

静的変換用メタデータ

cpprefjp/site_generator#28 で上がった需要をもとに共通化する試み。

ここに変更を加える場合は、今までの cpprefjp/site のコントリビューション基準に準じる。

article.md

記事に関係するメタデータ。

メタデータもMarkdownで記述する。見出しレベル2がキー、本文がデータ。

TOPLEVEL_CATEGORY

サイトの全ての記事の一番大きなカテゴリのIDと名前。サイドバーの一番上のアイテムに相当。

index というIDが与えられているものだけが特別で、これはサイトのデフォルトページの記事に対応するIDを指定する。この情報が必要ない場面では、無視される(サイドバーのツリーなどには、サイトルートへのリンクは無い)。

GLOBAL_QUALIFY_LIST

サイト全体の特別なキーワードの一覧。自動リンクで使う。

以前は site/GLOBAL_QUALIFY_LIST.txt にあった。


cpp.json

C++(言語)に直接関係したデータ

order_priority

リファレンスの説明対象のドメイン別のソート順序。サイドバーのツリーのソートなどで利用。

配列の1つ目の要素がID、2つ目の要素は開発用の説明文(エラー出力などに使っても使わなくても良い)。実際のソート順序は要素のインデックスを元に算出(例外は説明文を参照のこと)

以前は site_generator/settings/cpprefjp.py にあった。

Clone this wiki locally