amatl

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 9, 2024 License: MIT

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

  • Transform your Markdown to (formatted) Markdown, HTML or PDF (with the help of Chromium/Chrome), directly from the command line;
  • 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

  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

Directories

Path Synopsis
cmd
amatl command
pkg
markdown/renderer/markdown
Package markdown renders the given goldmark AST to Markdown.
Package markdown renders the given goldmark AST to Markdown.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL