Skip to content

getDemoVaultArchiveFileName

The file name of the demo-vault archive attached to a plugin’s GitHub release.

Carries the plugin id so several plugins’ demo vaults never collide, and deliberately NOT the version: a release asset is already namespaced by its release tag (…/releases/download/<version>/…), so the version bought no disambiguation while making the asset name change on every release — which is what broke the Community directory’s finding overrides, whose fingerprint includes the name. The version lives inside the archive instead, as getDemoVaultFolderName and on the README’s heading.

Import:

import { getDemoVaultArchiveFileName } from 'obsidian-dev-utils/obsidian/demo-vault-naming';

Signature:

function getDemoVaultArchiveFileName(pluginId: string): string

Parameters:

ParameterTypeDescription
pluginIdstringThe plugin id the vault demonstrates.

Returns: string — The archive file name, e.g. my-plugin-demo-vault.zip.