Covfefe v0.0.1 API Reference

Modules

Dependency

Given a list of parsed lines, convert them into blocks. That list of blocks is the final representation of the document (in internal form)

Instead of carrying error messages and warnings around we register them in this agent and retrieve them at the end when all scanning, parsing and rendering tasks are joined again for the final result

Match and render inline sequences, passing each to the renderer

Give a line of text, return its context-free type. Not for external consumption

Plugins are modules that implement a render function. Right now that is as_html

Elixir Documentation System. ExDoc produces documentation for Elixir projects

Command line parser for ExDoc

Configuration structure that holds all the available options for ExDoc

Provide EPUB documentation

Generate HTML documentation for Elixir projects

Conveniences for autolinking locals, types and more

Structure that holds all the elements of an individual function

Transform a given document in Markdown to HTML

ExDoc extension for the Cmark Markdown parser

ExDoc extension for the Earmark MarkDown parser

ExDoc extension for the Hoedown MarkDown parser

Structure that represents a module

Functions to extract documentation information from modules

Structure that holds all the elements of an individual type

Exceptions

Structure that hold the message of a given exception

Mix Tasks

Uses ExDoc to generate a static web page from the project documentation