pandoc-filter-lc

Name	pandoc-filter-lc JSON
Version	0.1 JSON
	download
home_page	None
Summary	a pandoc filter for mermaid
upload_time	2024-09-23 09:18:51
maintainer	None
docs_url	None
author	Clovis Heaulier
requires_python	>=2.7
license	MIT
keywords	pandoc mermaid
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pandoc-filter-lc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=2.7",
    "maintainer_email": null,
    "keywords": "pandoc mermaid",
    "author": "Clovis Heaulier",
    "author_email": "clovis.heaulier@gmail.com",
    "download_url": null,
    "platform": null,
    "description": "# pandoc-mermaid-filter\n\nPandoc filter which converts mermaid code blocks to mermaid images.\n\n````\n```mermaid\ngantt\n        dateFormat  YYYY-MM-DD\n        title Adding GANTT diagram functionality to mermaid\n        section A section\n        Completed task            :done,    des1, 2014-01-06,2014-01-08\n        Active task               :active,  des2, 2014-01-09, 3d\n        Future task               :         des3, after des2, 5d\n        Future task2               :         des4, after des3, 5d\n        section Critical tasks\n        Completed task in the critical line :crit, done, 2014-01-06,24h\n        Implement parser and jison          :crit, done, after des1, 2d\n        Create tests for parser             :crit, active, 3d\n        Future task in critical line        :crit, 5d\n        Create tests for renderer           :2d\n        Add to mermaid                      :1d\n```\n````\n\n## Usage\n\nInstall it with pip:\n\n```\npip install pandoc-mermaid-filter\n```\n\nAnd use it like any other pandoc filter:\n\n```\npandoc tests/sample.md -o sample.pdf --filter pandoc-mermaid\n```\n\nThe mermaid binary must be in your `$PATH` or can be set with the\n`MERMAID_BIN` environment variable.\n\nBy setting the environment variable `PUPPETEER_CFG`, you can pass a custom\nconfiguration file to `mermaid` (`-p` option).\n\n## But there is ...\n\nThere are a few other filters trying to convert mermaid code blocks however\nthey all failed for me.\n\n### Troubleshoot\n\nI've had to install the mermaid CLI locally instead of globally. See https://github.com/mermaidjs/mermaid.cli/issues/16\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "a pandoc filter for mermaid",
    "version": "0.1",
    "project_urls": null,
    "split_keywords": [
        "pandoc",
        "mermaid"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4acd0ab40fa4c205b6c25b0bd863f99670b701bd0fe3afb2e284da063e8f2d0",
                "md5": "71d062003f1fc4a14190764b8191c65b",
                "sha256": "5f5c85f37ee2191ba4a8809972c17073144d50b4a828de0eaf1781a6a4828e95"
            },
            "downloads": -1,
            "filename": "pandoc_filter_lc-0.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "71d062003f1fc4a14190764b8191c65b",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7",
            "size": 3336,
            "upload_time": "2024-09-23T09:18:51",
            "upload_time_iso_8601": "2024-09-23T09:18:51.915769Z",
            "url": "https://files.pythonhosted.org/packages/a4/ac/d0ab40fa4c205b6c25b0bd863f99670b701bd0fe3afb2e284da063e8f2d0/pandoc_filter_lc-0.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-23 09:18:51",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pandoc-filter-lc"
}