Skip to content

DemoVaultAuthoringSpec

Tunes the always-on authoring checks. It cannot disable them — see the file overview.

Import:

import type { DemoVaultAuthoringSpec } from 'obsidian-dev-utils/script-utils/demo-vault-coverage';

Signature:

export interface DemoVaultAuthoringSpec

Properties

PropertyTypeDescription
excludedNotes?string[]The notes (paths relative to the demo vault) that sit outside the learning path and are therefore exempt from every authoring check. Defaults to the vault's own README.md, which addresses someone browsing the repo on GitHub rather than a reader working through the vault.
startNote?stringThe note (path relative to the demo vault) every other note must be reachable from. Defaults to 00 Start.md.

Links to this page: