muextensions 0.0.13

Markup extentions

muextensions

Table of contents

• muextensions

  • Usage

    • Prerequisites

    • Hovercraft!

    • Pelican

  • Appendix

    • Todo list

    • References

Usage

Prerequisites

Install PlantUML and have a wrapper script with the name plantuml that executes it installed in your path. A sample wrapper script is included in contrib/scripts/plantuml of this project.

Hovercraft!

Support for Hovercraft! is currently pending pull request regebro/hovercraft#196 which adds the --directive-plugin argument to the hovercraft command. The source code introducing --directive-plugin can be found in pedrohdz/hovercraft under the directives branch.

Here is a quick example to see muextensions, make sure to complete the Prerequisites first. We will utilize the demo presentation in docs/examples/hovercraft/.

cd docs/examples/hovercraft/
python3.7 -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install muextensions \
    https://github.com/pedrohdz/hovercraft/archive/directives.zip
hovercraft --directive-plugin muextensions.contrib.hovercraft demo.rst

Open http://localhost:8000/ in a web browser to see the Hovercraft! presentation.

Pelican

Coming soon

Appendix

Todo list

1. Add plantuml-txt directive.

2. X - Connect to Pelican.

3. Add caching.

4. Add Ditaa (sp?)

5. Add REST callers for execs.

6. Look into https://pypi.org/project/pbr/

References

• TODO