Skip to main content

Module markdown

Module markdown 

Source
Expand description

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.

Structs§

Options
Tree
Unresolved
A reference written as plain text because it leads nowhere in the tree.

Enums§

Target

Constants§

MANIFEST

Functions§

build
Builds the tree in memory; nothing is written.
check_out
github_slug
GitHub’s heading slug: lower case, punctuation dropped, spaces to -.
write
Whether out may be written: missing, empty, or holding a previous export’s manifest. Returns the files the previous export wrote. Writes the tree and its manifest, removing the files of the previous export first.