Arcdown v0.1.2 Arcdown View Source

Arcdown is a parsing library for articles written in Arcdown (.ad) format.

It is written in pure Elixir/Erlang with no additional dependencies when being used in production.

This top-level Arcdown module is mostly populated with a helper interface provided for convenience and clarity in implementation.

Link to this section Summary

Wrapper method for directly parsing a text from Arcdown format into an object

Wrapper method for reading an article from a file, then parsing its contents

parse(text)

parse(binary()) :: {atom(), Article.t() | binary()}

Wrapper method for directly parsing a text from Arcdown format into an object.

parse_file(path)

parse_file(binary()) :: {atom(), Article.t() | binary()}

Wrapper method for reading an article from a file, then parsing its contents.