Skip to main content

Module export

Module export 

Source
Expand description

Exporting the corpus: the extended plugin payload (bodies and resolved links) and the built-in markdown exporter that writes a tree for Obsidian, MkDocs, Docusaurus or a GitHub wiki.

Modules§

links
Every [[reference]] in a body with its byte span and what it resolves to, using the same resolution as rule L1 (ids, aliases, paths, anchors and remotes).
markdown
The built-in markdown exporter: a plain Markdown tree laid out for one target (Obsidian, MkDocs, Docusaurus or a GitHub wiki). [[references]] become that target’s links; a reference that leads nowhere in the tree (unresolved, in a remote, or to a document left out) is written as plain text and reported. The output directory must be empty or a previous export, recognised by its manifest, whose files alone are replaced.
payload
The payload an exporter plugin asked for with wants: bodies, resolved links and a hash on top of the compact view every plugin gets. Plugins that ask for nothing get the compact view.

Constants§

BUILT_IN
The exporter name specfold keeps for itself; a configured plugin may not use it.