amatl

README

amatl

Transform your CommonMark (also known as Markdown) files into full-fledged documents from the command line.

Why the name amatl ?

Amate (Spanish: amate [aˈmate] from Nahuatl languages: āmatl [ˈaːmat͡ɬ] is a type of bark paper that has been manufactured in Mexico since the precontact times. It was used primarily to create codices.

Source: Wikipédia

Features

• Create document from local or remote resources via URL resolving;
• Integrate MermaidJS diagrams et code blocks with syntax highlighting;
• Use custom directives to include others documents or generate tables of content;
• Use pre-defined or custom layouts to transform your content into presentations, report, etc;
• Use Go templating to inject dynamic data into your document.

How to use

Caution ⚠

This project is in its early stages and subject to rapid evolution. Expect frequent changes and potential instability.

1. Download the latest release of amatl
2. In your terminal, start transforming your documents to HTML:

amatl render html my-doc.md

See ./doc for more informations.

Licence

MIT