Skip to content

listNotesWithButtons

Lists the demo vault’s notes that declare at least one code-button, walking group folders too.

A vault big enough to need grouping puts its walkthroughs in numbered folders — and a root-only walk finds NONE of them, which is worse than it sounds: a vault whose notes are all grouped reports zero notes, and one that is partly grouped silently gates only the ungrouped part. Fixture and asset folders are still skipped, so what is walked is walkthroughs and nothing else.

Import:

import { listNotesWithButtons } from '@mnaoumov/obsidian-dev-toolkit/demo-vault-buttons';

Signature:

function listNotesWithButtons(demoVaultPath: string, excludedNotes: ReadonlySet<string>, excludedFolders: ReadonlySet<string>): DemoVaultNote[]

Parameters:

Parameter Type Description
demoVaultPath string The demo vault root.
excludedNotes ReadonlySet<string> Note names to skip, matched against both the file name and the path relative to the vault root.
excludedFolders ReadonlySet<string> Folders to skip whole, matched the same way.

Returns: DemoVaultNote[] — The notes, sorted by path.