コンテンツにスキップ

変数システム

変数を使うと、値を一箇所で定義して、ドキュメント内の複数箇所で使い回すことができます。プレビュー時に {{変数名}} のプレースホルダーが実際の値に置き換えられます。

これは Bokuchi 独自の機能です。テンプレート、レポート、社内文書など、同じ情報(プロジェクト名、日付、著者名など)を何箇所にも書くドキュメントで特に便利です。

ドキュメント内のどこにでも {{変数名}} と書きます。プレビューでは、定義した値に置き換えて表示されます。

変数 authorAlice という値を定義すると:

著者: {{author}}

プレビューでは以下のように表示されます:

著者: Alice

グローバル変数はすべてのファイルで共通して使えます。設定パネルで管理します。

  1. 設定 を開きます(macOS: Cmd+, / Windows/Linux: Ctrl+,)
  2. グローバル変数 タブに移動します
  3. 変数名と値を入力し、追加 をクリックします
設定画面のグローバル変数タブ
  • 会社名、部署名
  • 著者名
  • よく使う URL やパス
変数が展開されたプレビューの例

特定のファイルだけで使える変数を、ファイル冒頭の HTML コメントで定義できます:

<!-- @var title: 月次レポート -->
<!-- @var date: 2026-03-01 -->
<!-- @var author: Alice -->
# {{title}}
日付: {{date}}
著者: {{author}}
<!-- @var 変数名: 値 -->

同じ名前の変数がローカルとグローバルの両方で定義されている場合:

  1. ファイルローカル変数 — 優先して使用されます
  2. グローバル変数 — ローカル定義がない場合に使用されます
  3. 未定義{{変数名}} がそのまま表示されます

グローバル変数を YAML ファイルにエクスポートし、他のマシンにインポートしたり、チームで共有したりできます。

  • エクスポート: 設定 > グローバル変数 > エクスポート
  • インポート: 設定 > グローバル変数 > インポート

Bokuchi では、すべての変数を実際の値に置き換えた状態でドキュメントのコピーを保存できます。最終版を共有する際に便利です。

  • 設定 — グローバル変数の管理
  • エクスポート — 変数展開済みのドキュメントを出力する