Crate yarner_lib
source · [−]Expand description
yarner-lib
is a simple library for building plugins for the Literate Programming tool Yarner.
See chapter Writing plugins of the Yarner user guide on how to use it.
Structs
A CodeBlock
is a block of code as defined by the input format.
Plugin call context
A representation of a Document
of literate code
A TextBlock
is just text that will be copied verbatim into the output documentation file
A Transclusion
is a reference to another file that should be pulled into the source
Plugin call context
Enums
A Source
represents the source code on a line.
A node, representing text and code blocks, as well as transclusions
Constants
Version of this library
Functions
Read inputs from STDIN and parse into Context and Documents
Write Documents as JSON to STDOUT