# Carvex v0.0.1 - API Reference

## Modules

- [Carvex](Carvex.md): [Carve](https://markup-carve.github.io/carve/) parsing and rendering, backed by
the Rust [carve-rs](https://github.com/markup-carve/carve-rs) engine.
- [Carvex.Abbreviation](Carvex.Abbreviation.md): The Carve `abbreviation` node.
- [Carvex.AbbreviationDef](Carvex.AbbreviationDef.md): The Carve `abbreviation_def` node.
- [Carvex.Admonition](Carvex.Admonition.md): The Carve `admonition` node.
- [Carvex.Attributes](Carvex.Attributes.md): A node's attributes, as carve's AST carries them.
- [Carvex.Autolink](Carvex.Autolink.md): The Carve `autolink` node.
- [Carvex.BlockExtension](Carvex.BlockExtension.md): The Carve `block_extension` node.
- [Carvex.BlockQuote](Carvex.BlockQuote.md): The Carve `block_quote` node.
- [Carvex.CaptionNumber](Carvex.CaptionNumber.md): The Carve `caption_number` node.
- [Carvex.CellWrap](Carvex.CellWrap.md): The Carve `cell_wrap` node.
- [Carvex.Citation](Carvex.Citation.md): The Carve `citation` node.
- [Carvex.CitationDefinition](Carvex.CitationDefinition.md): The Carve `citation_definition` node.
- [Carvex.CitationGroup](Carvex.CitationGroup.md): The Carve `citation_group` node.
- [Carvex.Code](Carvex.Code.md): The Carve `code` node.
- [Carvex.CodeBlock](Carvex.CodeBlock.md): The Carve `code_block` node.
- [Carvex.Comment](Carvex.Comment.md): The Carve `comment` node.
- [Carvex.CriticComment](Carvex.CriticComment.md): The Carve `critic_comment` node.
- [Carvex.DefinitionDescription](Carvex.DefinitionDescription.md): The Carve `definition_description` node.
- [Carvex.DefinitionList](Carvex.DefinitionList.md): The Carve `definition_list` node.
- [Carvex.DefinitionTerm](Carvex.DefinitionTerm.md): The Carve `definition_term` node.
- [Carvex.Delete](Carvex.Delete.md): The Carve `delete` node.
- [Carvex.Directive](Carvex.Directive.md): The Carve `directive` node.
- [Carvex.Div](Carvex.Div.md): The Carve `div` node.
- [Carvex.Document](Carvex.Document.md): A Carve document: a tree of nodes plus a Req-like pipeline of options and steps.
- [Carvex.Emphasis](Carvex.Emphasis.md): The Carve `emphasis` node.
- [Carvex.EscapedText](Carvex.EscapedText.md): The Carve `escaped_text` node.
- [Carvex.Figure](Carvex.Figure.md): The Carve `figure` node.
- [Carvex.FigureGroup](Carvex.FigureGroup.md): The Carve `figure_group` node.
- [Carvex.Footnote](Carvex.Footnote.md): The Carve `footnote` node.
- [Carvex.FootnoteRef](Carvex.FootnoteRef.md): The Carve `footnote_ref` node.
- [Carvex.Frontmatter](Carvex.Frontmatter.md): The Carve `frontmatter` node.
- [Carvex.HardBreak](Carvex.HardBreak.md): The Carve `hard_break` node.
- [Carvex.Heading](Carvex.Heading.md): The Carve `heading` node.
- [Carvex.HeadingRef](Carvex.HeadingRef.md): The Carve `heading_ref` node.
- [Carvex.Highlight](Carvex.Highlight.md): The Carve `highlight` node.
- [Carvex.Image](Carvex.Image.md): The Carve `image` node.
- [Carvex.InlineExtension](Carvex.InlineExtension.md): The Carve `inline_extension` node.
- [Carvex.InlineFootnote](Carvex.InlineFootnote.md): The Carve `inline_footnote` node.
- [Carvex.Insert](Carvex.Insert.md): The Carve `insert` node.
- [Carvex.LineBlock](Carvex.LineBlock.md): The Carve `line_block` node.
- [Carvex.Link](Carvex.Link.md): The Carve `link` node.
- [Carvex.LinkReferenceDefinition](Carvex.LinkReferenceDefinition.md): The Carve `link_reference_definition` node.
- [Carvex.LintWarning](Carvex.LintWarning.md): A diagnostic returned by `Carvex.lint/2`.
- [Carvex.List](Carvex.List.md): The Carve `list` node.
- [Carvex.ListItem](Carvex.ListItem.md): The Carve `list_item` node.
- [Carvex.LiteralInline](Carvex.LiteralInline.md): The Carve `literal_inline` node.
- [Carvex.Math](Carvex.Math.md): The Carve `math` node.
- [Carvex.Mention](Carvex.Mention.md): The Carve `mention` node.
- [Carvex.NonBreakingSpace](Carvex.NonBreakingSpace.md): The Carve `non_breaking_space` node.
- [Carvex.Paragraph](Carvex.Paragraph.md): The Carve `paragraph` node.
- [Carvex.Pos](Carvex.Pos.md): A node's source span, present when parsed with `parse: [positions: true]`.
- [Carvex.Raw](Carvex.Raw.md): Raw HTML emitted verbatim in HTML output, regardless of `safe:` or profiles.
- [Carvex.RawBlock](Carvex.RawBlock.md): The Carve `raw_block` node.
- [Carvex.RawInline](Carvex.RawInline.md): The Carve `raw_inline` node.
- [Carvex.Ruby](Carvex.Ruby.md): The Carve `ruby` node.
- [Carvex.RubyPair](Carvex.RubyPair.md): One base/annotation pair of a `Carvex.Ruby` node.
- [Carvex.Section](Carvex.Section.md): The Carve `section` node.
- [Carvex.Sigil](Carvex.Sigil.md): The `~CRV` sigil, evaluated at compile time.
- [Carvex.SmallCaps](Carvex.SmallCaps.md): The Carve `small_caps` node.
- [Carvex.SmartPunctuation](Carvex.SmartPunctuation.md): The Carve `smart_punctuation` node.
- [Carvex.SoftBreak](Carvex.SoftBreak.md): The Carve `soft_break` node.
- [Carvex.Span](Carvex.Span.md): The Carve `span` node.
- [Carvex.Strike](Carvex.Strike.md): The Carve `strike` node.
- [Carvex.Strong](Carvex.Strong.md): The Carve `strong` node.
- [Carvex.Subscript](Carvex.Subscript.md): The Carve `subscript` node.
- [Carvex.Substitution](Carvex.Substitution.md): The Carve `substitution` node.
- [Carvex.Superscript](Carvex.Superscript.md): The Carve `superscript` node.
- [Carvex.Symbol](Carvex.Symbol.md): The Carve `symbol` node.
- [Carvex.Table](Carvex.Table.md): The Carve `table` node.
- [Carvex.TableCell](Carvex.TableCell.md): The Carve `table_cell` node.
- [Carvex.TableRow](Carvex.TableRow.md): The Carve `table_row` node.
- [Carvex.Tag](Carvex.Tag.md): The Carve `tag` node.
- [Carvex.Text](Carvex.Text.md): The Carve `text` node.
- [Carvex.ThematicBreak](Carvex.ThematicBreak.md): The Carve `thematic_break` node.
- [Carvex.Underline](Carvex.Underline.md): The Carve `underline` node.

- Exceptions
  - [Carvex.CarveError](Carvex.CarveError.md): Raised (or returned) when parsing, rendering, sanitizing, or highlighting a Carve document fails.

