# readmix v0.8.0 - Table of Contents

> A tool to generate parts of documentation with custom generator functions.

## Modules

- [Generated](Generated.md): Struct representing a generated block in Readmix.

- [Readmix](Readmix.md): Readmix is a tool for generating and maintaining documentation with dynamic
content.
- [Readmix.BlockSpec](Readmix.BlockSpec.md): Defines the structure for generated blocks found in documents.

- [Readmix.Blocks.Generated](Readmix.Blocks.Generated.md): Struct representing a generated block in Readmix.

- [Readmix.Blocks.Text](Readmix.Blocks.Text.md): Struct representing a text block in Readmix.

- [Readmix.Context](Readmix.Context.md): Helpers to access the context in generator actions.

- [Readmix.Docs](Readmix.Docs.md): Utilities for generating documentation for Readmix generators.

- [Readmix.Generator](Readmix.Generator.md): Defines the behavior and utilities for Readmix generators.
- [Readmix.Generators.BuiltIn](Readmix.Generators.BuiltIn.md): Implements the built-in generators for Readmix.
- [Readmix.Parser](Readmix.Parser.md): Parses documents for Readmix blocks embedded in HTML comments.
- [Readmix.Scope](Readmix.Scope.md): Defines the scope behaviour for Readmix scopes.
- [Readmix.Scopes.Defaults](Readmix.Scopes.Defaults.md): This is the default Readmix scope that provides variables to generator
actions.

- Exceptions
  - [Readmix.Error](Readmix.Error.md): A generic exception for Readmix errors.

  - [Readmix.Parser.ParseError](Readmix.Parser.ParseError.md): Exception raised when a document cannot be parsed for Readmix blocks.

## Mix Tasks

- [mix rdmx.update](Mix.Tasks.Rdmx.Update.md): Updates Readmix blocks in a file.

