jekyllの変数のデータ構造

投稿日: 2022年09月25日 12:00 JST
更新日: 2022年12月31日 00:00 JST

liquidでjekyllの変数を色々弄るのに、どんなデータ構造の構造体になっているのか気になったので調べてみました。

前提

GitHub Pagesで使用されているバージョンjekyll 3.9.2を前提に説明します。が、jekyll 4.0以降でもあまり変わりがないようです。(キャッシュの設定が追加されただけ？)

データ構造についてはJavascriptライクな似非言語で書いています。自分が理解するためだけに書いたので適当です。
大文字で書かれている変数名やオブジェクト名は、説明のため当方で勝手に付けた名称ですので注意してください。

調べるにあたって、以下のjekyllの公式ドキュメントサイトを参考にしています。

• 変数一覧
• デフォルト設定
• オプション設定
• Markdownオプション
• Liquidオプション
• Front Matter
• コレクション
• 静的ファイル
• ページネーター

実際に動作を確認しながら書いていますが、誤りがあるかもしれません。その点はご了承ください。

データ構造一覧

全てのオブジェクトはグローバルのlayout、page、paginator、siteのいずれかにぶら下がる構成となっています。

GLOBAL = {
  "content"           : <string>,
  "layout"            : LAYOUT<object>,
  "page"              : PAGE<object>,
  "paginator"         : PAGINATOR<object>,
  "site"              : SITE<object>
};

LAYOUT = {
  "layout"            : <string>
  // other custom parameter start (ex.)
    ...etc (custom parameter)
  // other custom parameter end
}

PAGE = {
  "content"           : <string>,
  "output"            : <string>,
  "next"              : PAGE<object>
  "previous"          : PAGE<object>
  "id"                : <string>,
  "relative_path"     : <string>,
  "collection"        : <string>,
  "categories"        : <array> , // => [CATEGORY_NAME<string>, ...];
  "draft"             : <bool>  ,
  "tags"              : <array> , // => [TAG_NAME<string>, ...];
  "slug"              : <string>,
  "ext"               : <string>,
  "dir"               : <string>,
  "name"              : <string>,
  "url"               : <string>, 
  "path"              : <string>,
  "title"             : <string>,
  "layout"            : <string>,
  "date"              : <string>,
  "excerpt"           : <string>,
  // front matter start (ex.)
  "image"             : <string>,
  "author"            : <string>,
  "description"       : <string>,
  "summary"           : <string>,
    ...etc
  // front matter end
}

PAGINATOR = {
  "page"              : <integer>,
  "per_page"          : <integer>,
  "posts"             : <array>  , // => [PAGE<object>, ...];
  "total_posts"       : <integer>,
  "total_pages"       : <integer>,
  "previous_page"     : <integer>,
  "previous_page_path": <string>,
  "next_page"         : <integer>,
  "next_page_path"    : <string>
}

SITE = {
  "tags"              : <array> , // => [TAG<array>, ...];  TAG => [TAG_NAME<string>, PAGES<array>]; PAGES => [PAGE<object>, ...];
  "time"              : <string>,
  "pages"             : <array> , // => [PAGE<object>, ...];
  "posts"             : <array> , // => [PAGE<object>, ...];
  "documents"         : <array> , // => [PAGE<object> or STATIC_FILE<object>, ...];
  "related_posts"     : <array> , // => [PAGE<object>, ...];
  "html_pages"        : <array> , // => [PAGE<object>, ...];
  "static_files"      : <array> , // => [STATIC_FILE<object>, ...];
  "categories"        : CATEGORIES<object> , 
  "collections"       : <array> , // => [COLLECTION<object>, ...];
  "data"              : DATA<object>,
  "source"            : <string>,
  "destination"       : <string>,
  "collections_dir"   : <string>,
  "plugins_dir"       : <string>,
  "layouts_dir"       : <string>,
  "data_dir"          : <string>,
  "includes_dir"      : <string>,
  "safe"              : <bool>  ,
  "include"           : <array> , // => [FILE_DIR_NAME<string>, ...];
  "exclude"           : <array> , // => [FILE_DIR_NAME<string>, ...];
  "keep_files"        : <array> , // => [FILE_DIR_NAME<string>, ...];
  "encoding"          : <string>,
  "markdown_ext"      : <string>,
  "strict_front_matter": <bool> ,
  "show_drafts"       : <bool>  ,
  "limit_posts"       : <integer>,
  "future"            : <bool>  ,
  "unpublished"       : <bool>  ,
  "whitelist"         : <array> , // => [WITELIST_NAME<string>, ...];
  "plugins"           : <array> , // => [PLUGINS_NAME<string>, ...];
  "markdown"          : <string>,
  "highlighter"       : <string>,
  "lsi"               : <bool>  ,
  "excerpt_separator" : <string>,
  "incremental"       : <bool>  ,
  "detach"            : <bool>  ,
  "port"              : <string>,
  "host"              : <string>,
  "baseurl"           : <string>,
  "show_dir_listing"  : <bool>  ,
  "permalink"         : <string>,
  "paginate_path"     : <string>,
  "timezone"          : <string>,
  "quiet"             : <bool>  ,
  "verbose"           : <bool>  ,
  "defaults"          : <array>,  // => [YAML<object>, ...];
  "liquid"            : LIQUID<object>,
  "kramdown"          : KRAMDOWN<object>,
  "livereload_port"   : <integer>,
  "serving"           : <bool>  ,
  "watch"             : <bool>  ,
  "theme"             : <string>,
  "url"               : <string>,
  // _config.yml other custom parameter start (ex.)
  "lang"              : <string>,
  "title"             : <string>,
  "tagline"           : <string>,
  "description"       : <string>,
  "domain"            : <string>,
  "favicon"           : <string>,
  "theme_color"       : <string>,
  "paginate"          : <integer>,
    ...etc (custom parameter)
  // _config.yml other custom parameter end
};

CATEGORIES = {
  CATEGORY_NAME       : <array>, // => [PAGE<object>, ...];
  ...
};

DATA = {
  YAML_FILE_NAME      : YAML_OBJECT<object>,
  ...
};
YAML_OBJECT = #parse_from_file_to_object(YAML_FILE_NAME.yml);

COLLECTIONS = {
  "output"            : <bool>  ,
  "label"             : <string>,
  "directory"         : <string>,
  "docs"              : <array> ,// => [DOC<strings>, ...];
  "relative_directory": <string>,
  "files"             : <array> ,// => [STATIC_FILE<object>, ...];
};

STATIC_FILE = {
  "modified_time"     : <string>,
  "name"              : <string>,
  "basename"          : <string>,
  "extname"           : <string>,
  "collection"        : <string>,
  "path"              : <string>
}

LIQUID = {
  "error_mode"        : <string>,
  "strict_filters"    : <bool>  ,
  "strict_variables"  : <bool>  ,
  ...
}

KRAMDOWN = {
  "auto_ids"          : <bool>,
  "entity_output"     : <string>,
  "toc_levels"        : <string>,
  "smart_quotes"      : <string>,
  "input"             : <string>,
  "hard_wrap"         : <bool>  ,
  "footnote_nr"       : <integer>,
  "show_warnings"     : <bool>  ,
  ...
}

初期値と詳細説明

グローバル変数

LAYOUTオブジェクト

PAGEオブジェクト

PAGINATORオブジェクト

SITEオブジェクト

COLLECTIONオブジェクト

STATIC_FILEオブジェクト

LIQUIDオブジェクト

KRAMDOWNオブジェクト