Crate yarner_lib[−][src]

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

CodeBlock	A `CodeBlock` is a block of code as defined by the input format.
Context	Plugin call context
Document	A representation of a `Document` of literate code
TextBlock	A `TextBlock` is just text that will be copied verbatim into the output documentation file
Transclusion	A `Transclusion` is a reference to another file that should be pulled into the source
YarnerData	Plugin call context

Line	A `Source` represents the source code on a line.
Node	A node, representing text and code blocks, as well as transclusions

Version of this library

parse_input	Read inputs from STDIN and parse into Context and Documents
write_output	Write Documents as JSON to STDOUT