# md v0.15.1 - Table of Contents

> Custom extendable markdown parser.

## Pages

- [Md](readme.md)
- [Custom Markdown Pipelines](md-benefits.md)
- [Handler Parameters Reference](handler-parameters.md)

## Modules

- [Md](Md.md): `Md` is a markup parser allowing fully customized syntax definition and
understanding the wide range of [markdown](https://www.markdownguide.org/) out of the box.
- [Md.Guards](Md.Guards.md): Several guards for the proper UTF8 handling of input.
- [Md.Parser](Md.Parser.md): Interface to implement for the custopm parsers.
- [Md.Transforms](Md.Transforms.md): Custom transforms behaviour to be implemented by custom handlers

- Parser Internals
  - [Md.Attributes](Md.Attributes.md): Sanitisation of the inline attributes declared with the `attributes` handler
(`{{class: "highlight"}}`).
  - [Md.Deferred](Md.Deferred.md): Resolution of deferred references.
  - [Md.Parser.Default](Md.Parser.Default.md): Default parser with all the features included.
  - [Md.Parser.Error](Md.Parser.Error.md): Diagnostic reporting for an input the generated parser has no clause for.
  - [Md.Parser.State](Md.Parser.State.md): The internal state of the parser.

  - [Md.Parser.Syntax](Md.Parser.Syntax.md): The behaviour for the custom syntax suppliers

  - [Md.Parser.Syntax.Void](Md.Parser.Syntax.Void.md): Void syntax to be extended by custom implementations. Included for convenience.

- Listeners
  - [Md.Listener](Md.Listener.md): The listener behaviour to attach to the parser to receive callbacks
when the elements are encountered and processed.

  - [Md.Listener.Debug](Md.Listener.Debug.md): A listener that logs every parsing event at `:debug` level. Useful when
writing a custom syntax; never enable it in production.

  - [Md.Listener.Sanitizer](Md.Listener.Sanitizer.md): A listener that strips unsafe markup from the AST as it is built.

- Custom Transforms
  - [Md.Transforms.Anchor](Md.Transforms.Anchor.md): Anchor transformation to image or twitter card
  - [Md.Transforms.Footnote](Md.Transforms.Footnote.md): Internal transformation to format footnotes
  - [Md.Transforms.Soundcloud](Md.Transforms.Soundcloud.md): Internal transformation to embed soundcloud audios
  - [Md.Transforms.TwitterHandle](Md.Transforms.TwitterHandle.md): Internal transformation to format twitter handles
  - [Md.Transforms.Youtube](Md.Transforms.Youtube.md): Internal transformation to embed youtube videos

## Mix Tasks

- [mix md.render](Mix.Tasks.Md.Render.md): Renders a markdown file (or standard input) to HTML.