script-utils/demo-vault
Archives a plugin’s demo vault as a release artifact.
A plugin can ship a curated demo vault at demo-vault/ in its repo root. At release time this module installs the freshly built plugin into that vault’s .obsidian/plugins/<id>/ folder and zips the whole vault into dist/build/<plugin-id>-demo-vault-<version>.zip, so the existing GitHub-release step (which uploads every file in dist/build/) attaches it automatically. The archive name carries the plugin id (so several plugins’ demo vaults never collide) and the version (so each release ships its own distinctly named artifact).
Functions
Section titled “Functions”| Function | Description |
|---|---|
| archivePluginDemoVault | Archives the plugin’s demo vault (demo-vault/ in the repo root) as a release artifact. Installs the freshly built plugin from dist/build/ into the vault’s .obsidian/plugins/<id>/ folder, then zips the whole vault to dist/build/<plugin-id>-demo-vault-<version>.zip. |