一般サイトで使用できる変数

config.yml や任意の Markdown ファイル .md の先頭には YAML でデータ変数を定義することができます。

config.yml ファイルに定義できる変数

変数         説明
siteurlサイトの URL を指定します。サイト URL http:// または https:// から始まります。末尾には / を含みません。末尾に / を含めた場合は自動的に取り除かれます。タイトルのリンク URL sitemap.xml OGP プロパティ og:url で使用されます。
iconアイコンファイルをルートフォルダー config.yml のあるパス からの相対パスで指定します。このアイコンはタイトルバーに表示されます。ブラウザーのタブ等に表示される favicon ではありません。favicon を指定したい場合はルートフォルダーに favicon.ico を配置してください
titleタイトルを指定します。タイトルバーに表示されます。指定された値は <title> タグと OGP プロパティ og:site_name og:title にも設定されます。必要に応じて各ページの Markdown ファイルで上書き定義しましょう。
descriptionページの説明を指定します。指定された値は <meta name="description" content="..."> OGP プロパティ og:description に設定されます。各ページの Markdown ファイルで上書き定義しましょう。
authorページの著者名を指定します。著者名はページのフッターに表示されます。指定を省略すると著者名の代わりにメールアドレスが表示されます。
mailto著者のメールアドレスを指定します。ページフッターに表示される著者名またはメールアドレスの mailto リンクになります。メールアドレスの指定を省略するとページフッターに著者名もメールアドレスも表示されなくなります。
imageイメージファイルを siteurl からの相対パスで指定します。指定された値は OGP プロパティ og:image に設定されます。指定を省略すると og:image は出力されません。

Markdown ファイルに定義できる変数

変数         説明
templateMarkdown ファイルに適用するテンプレート名を指定します。指定を省略した場合 default.ftl がテンプレートとして適用されます。テンプレート名の指定では拡張子 .ftl を省略することもできます。テンプレートはルートフォルダーの templates フォルダーから検索されます。

Markdown ファイルの YAML フロント マターでは config.yml で定義されている変数を上書きしたり ユーザー独自の変数を定義することができます。title description などページごとに変えたほうが良いものはなるべく Markdown ファイルで指定するようにしましょう。

自動的に定義される変数

変数         説明
baseurlベース URL が相対パスで格納されます。ルートフォルダーに配置した Markdown ファイルで ${baseurl} を参照した場合 値は空文字になります。ルートフォルダーの sub フォルダーに配置した Markdown ファイルで ${baseurl} を参照した場合 値は ../ になります。たとえば ${baseurl}img はどの階層に配置された Markdown ファイルから参照してもルートフォルダーの img を指し示します。
pathページの ルートフォルダーを基準とした 相対パスが格納されます。この値は URL エンコードされていません。Freemarker の組み込み機能 ?url_path を使うことで URL エンコードされた文字列を参照できます。先頭に / スラッシュ は含まれません。${siteurl} と連結することでページの URL を表わすことができます。${siteurl!}/${path!?url_path}
urlページの URL が格納されます。この値は URL エンコードされています。${siteurl!}/${path!?url_path} と同等の値が格納されています。
dateModifiedページの最終更新日が格納されます。入力ソースとなった Markdown ファイル テンプレートファイル CSS ファイルの中で最も新しい日付が最終更新日となります。テンプレートファイルや CSS ファイルを書き換えると それを参照している複数のページの最終更新日付が更新されることに注意してください。ページに表示する最終更新日を明確にコントロールしたい場合は ${dateModified} を参照せずにユーザー定義の変数を参照するようにテンプレートを書き換えてください。
contentLastModifiedページコンテンツの最終更新日が格納されます。入力ソースとなった Markdown ファイルの日付が格納されます。テンプレートファイルや CSS ファイルを書き換えてもこの日付は影響を受けません。
_PREVIEWCatalpa のローカルサーバー機能でプレビューしていることを示すフラグです。プレビュー時は true になります。名前を付けて保存 するときは false になります。