Skip to content
pkm

Compatibility

pkm stores notes as plain Markdown files with YAML frontmatter. That gives the library a simple compatibility contract.

File Format

Section titled “File Format”
  • Markdown body
  • YAML frontmatter
  • Wikilinks for note references
  • Plain directories for organization
  • Hidden .pkm/ internals for pkm-owned state
Section titled “Wikilink Support”

pkm extracts common wikilink forms:

[[Note]]
[[Note|display text]]
[[Note#Heading]]
[[Note#^block-id]]
![[Embedded Note]]

Tooling

Section titled “Tooling”

Libraries work well with editors and PKM tools that understand Markdown, YAML properties, and wikilinks. Tool-specific configuration should live beside the notes and outside .pkm/.

Boundaries

Section titled “Boundaries”

pkm does not require a specific editor, sync service, or database server. If the Markdown files are present, the index can be rebuilt.