Metadata-Version: 2.1
Name: mau
Version: 1.2.0
Summary: A lightweight markup language
Home-page: https://github.com/Project-Mau/mau
Author: Leonardo Giordani
Author-email: giordani.leonardo@gmail.com
License: mit
Project-URL: Documentation, https://mau.readthedocs.io/en/latest/
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: jinja2
Requires-Dist: beautifulsoup4
Requires-Dist: pyyaml
Requires-Dist: pygments
Provides-Extra: development
Requires-Dist: tox ; extra == 'development'
Requires-Dist: jedi ; extra == 'development'
Requires-Dist: rope ; extra == 'development'
Requires-Dist: black ; extra == 'development'
Requires-Dist: flake8 ; extra == 'development'
Requires-Dist: punch.py ; extra == 'development'
Requires-Dist: twine ; extra == 'development'
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: pytest-icdiff ; extra == 'testing'

# Mau 

Mau is a lightweight markup language heavily inspired by [AsciiDoc](https://asciidoctor.org/docs/what-is-asciidoc), [Asciidoctor](https://asciidoctor.org/) and [Markdown](https://daringfireball.net/projects/markdown/).

As I wasn't satisfied by the results I got with those tools I decided to try to write my own language and the tool to render it.

I successfully used it to transpile my book ["Clean Architectures in Python"](https://www.pycabook.com) from Mau to Asciidoctor, as Mau is not ready to be used in my workflow yet (it can't create PDFs, for example).

## Quick start

To install Mau use `pip`

``` sh
pip install mau
```

To convert Mau sources into HTML just run

``` sh
mau -i source.mau -o destination.html -f html
```

To use Mau in your tool you can run it programmatically

``` python
from mau import Mau

mau = Mau(target_format="html")

mau.process(text)
```

## Support

You may report bugs or missing features use the [issues page](https://github.com/Project-Mau/mau/issues).
If you want to ask for help or discuss ideas use the [discussions page](https://github.com/Project-Mau/mau/discussions)

This project has been set up using PyScaffold 3.3.1. For details and usage information on PyScaffold see https://pyscaffold.org/.


