API Reference readmix v#0.8.1

Struct representing a generated block in Readmix.

Readmix is a tool for generating and maintaining documentation with dynamic content.

Defines the structure for generated blocks found in documents.

Struct representing a generated block in Readmix.

Struct representing a text block in Readmix.

Helpers to access the context in generator actions.

Utilities for generating documentation for Readmix generators.

A generic exception for Readmix errors.

Defines the behavior and utilities for Readmix generators.

Implements the built-in generators for Readmix.

Parses documents for Readmix blocks embedded in HTML comments.

Exception raised when a document cannot be parsed for Readmix blocks.

Defines the scope behaviour for Readmix scopes.

This is the default Readmix scope that provides variables to generator actions.

Updates Readmix blocks in a file.