TypeScript API / laikacms/documents/obsidian / ObsidianDocumentsRepositoryOptions

Interface: ObsidianDocumentsRepositoryOptions

Configuration for ObsidianDocumentsRepository.

An Obsidian vault is a flat directory of markdown notes with no built-in editorial workflow. This backend derives the published / unpublished state from a frontmatter property instead of from separate directories, matching the convention used by Obsidian Publish.

Properties

defaultStatus?

optional defaultStatus?: string;

Status reported for an unpublished note that has no explicit statusProperty. Defaults to 'draft'.

---

publishProperty?

optional publishProperty?: string;

Frontmatter property that marks a note as published. A note is treated as a published Document when this property is strictly true; otherwise it is an Unpublished draft. Defaults to 'publish' (the Obsidian Publish convention).

---

statusProperty?

optional statusProperty?: string;

Frontmatter property that records the editorial status of an unpublished note (draft, pending_review, ...). Defaults to 'status'.