Skip to main content

Module authoring

Module authoring 

Source
Expand description

Writing documents: create, change, move and fix. Every operation returns a plan; nothing touches the disk until the plan is applied.

Re-exports§

pub use plan::Change;
pub use plan::Plan;

Modules§

fix
Applying the fixes that need no judgement: exact replacements reported by rules, missing frontmatter keys, and a chosen target for an ambiguous reference.
mv
Moving or renaming a document, and rewriting every reference to it.
new
Creating a document: compute its owner and path, assign its key, write its frontmatter and body skeleton.
plan
Every write is planned first and applied only on request, so a preview and the real run do exactly the same thing.
refs
Rewriting references to a document when its id changes.
set
Changing frontmatter through assignments (key=value, key+=value, key-=value), with the lifecycle enforced and updated kept current.