Skip to content

Presets

Presets bundle Vault CMS settings for specific Astro themes so paths, content types, and plugin config match the theme without manual tuning.

Examples include Starlight, Chiri, and Slate. The full list is fetched at install time from the vaultcms-presets repository.

  1. From your Astro project root, run npx create-vaultcms (or npm / pnpm / yarn create vaultcms).
  2. When asked about a preset, choose Yes and pick your theme.
  3. Open the installed folder in Obsidian when the CLI offers.

Pass the template name explicitly:

Terminal window
npx create-vaultcms --template starlight
npx create-vaultcms --template chiri
npx create-vaultcms --template slate

You can also pass it as a positional argument:

Terminal window
npx create-vaultcms starlight

Typical behavior (exact steps depend on the preset):

  • Install target — e.g. Starlight may default to src/content without an extra prompt.
  • Vault-relative pathsVault CMS plugin config points at your project root correctly.
  • _GUIDE.md — Pulled from the main Vault CMS repo so the in-vault guide stays current.
  • .gitignore — Obsidian workspace state entries are added so only useful config is committed.

Astro Modular is a theme designed for Vault CMS end-to-end. See also Theme comparison.