Skip to main content

a pandoc filter for mermaid

Project description

pandoc-mermaid-filter

Pandoc filter which converts mermaid code blocks to mermaid images.

```mermaid
gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2               :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d
```

Usage

Install it with pip:

pip install pandoc-mermaid-filter

And use it like any other pandoc filter:

pandoc tests/sample.md -o sample.pdf --filter pandoc-mermaid

The mermaid binary must be in your $PATH or can be set with the MERMAID_BIN environment variable.

By setting the environment variable PUPPETEER_CFG, you can pass a custom configuration file to mermaid (-p option).

But there is ...

There are a few other filters trying to convert mermaid code blocks however they all failed for me.

Troubleshoot

I've had to install the mermaid CLI locally instead of globally. See https://github.com/mermaidjs/mermaid.cli/issues/16

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pandoc_filter_lc-0.1-py2.py3-none-any.whl (3.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pandoc_filter_lc-0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pandoc_filter_lc-0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5f5c85f37ee2191ba4a8809972c17073144d50b4a828de0eaf1781a6a4828e95
MD5 71d062003f1fc4a14190764b8191c65b
BLAKE2b-256 a4acd0ab40fa4c205b6c25b0bd863f99670b701bd0fe3afb2e284da063e8f2d0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page