前提

  • Valut直下にindex.mdを作成する必要がある
  • そのページのタイトルはフロントマターのtitleプロパティで設定する

1. インストール

公式レポジトリからUse this templateで良い
普通にクローンするのと違ってGitの履歴がきれいになる

ローカルで作業する場合はクローンして

cd quartz
npm i

2. contentの紐づけ

npx quartz create

ただしSubmoduleを使う場合はこれは実行すべきではない

補足:pnpmを使う

以下のようにすればpnpmで作業することも可能
(※pnpm execが使えなかった。npm cache権限の問題らしい)

pnpm i
node ./quartz/bootstrap-cli.mjs create

しかし、以下の理由からpnpmは非推奨

  • 今後本家の更新を取り込むことを考えると望ましくない
  • コンテンツの更新をGit Submodule&GitHub Actionsに任せれば、プロジェクトをローカルに置く必要がなくなり、そもそも不要