pandoc-d2-filter

Name	pandoc-d2-filter JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	Pandoc filter for D2 code blocks
upload_time	2024-10-15 15:07:23
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	MIT
keywords	d2 pandoc-filter pandoc
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            pandoc-d2-filter
================

Pandoc filter to convert d2 code blocks to images.

````
```{.d2 pad=20}
x -> y
```
````

## Usage

Install it with pip:

```
pip install pandoc-d2-filter
```

And use it like any other pandoc filter:

```
pandoc tests/testdata/default.md -o default.pdf --filter pandoc-d2
```

The d2 binary is either part of the `$PATH`
or can be configured via `D2_BIN` environment variable.
If you use other output formats than svg,
you should `d2 init-playwright` before the first use.

## Configuration

TODO check `tests/testdata` for now.

## Inspiration

This filter is heavily inspired by the
[JavaScript d2-filter](https://github.com/ram02z/d2-filter)
and the [pandoc-plantuml-filter](https://github.com/timofurrer/pandoc-plantuml-filter).

Thanks [Omar](https://github.com/ram02z) & [Timo](https://github.com/timofurrer)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pandoc-d2-filter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "d2, pandoc-filter, pandoc",
    "author": null,
    "author_email": "Fliiiix <hi@l33t.name>",
    "download_url": "https://files.pythonhosted.org/packages/a3/b5/fb4d42a4f58a294dabf8b617dcd3c9bc3482d4d93a624d3afdc40b53fc78/pandoc_d2_filter-0.1.0.tar.gz",
    "platform": null,
    "description": "pandoc-d2-filter\n================\n\nPandoc filter to convert d2 code blocks to images.\n\n````\n```{.d2 pad=20}\nx -> y\n```\n````\n\n## Usage\n\nInstall it with pip:\n\n```\npip install pandoc-d2-filter\n```\n\nAnd use it like any other pandoc filter:\n\n```\npandoc tests/testdata/default.md -o default.pdf --filter pandoc-d2\n```\n\nThe d2 binary is either part of the `$PATH`\nor can be configured via `D2_BIN` environment variable.\nIf you use other output formats than svg,\nyou should `d2 init-playwright` before the first use.\n\n## Configuration\n\nTODO check `tests/testdata` for now.\n\n## Inspiration\n\nThis filter is heavily inspired by the\n[JavaScript d2-filter](https://github.com/ram02z/d2-filter)\nand the [pandoc-plantuml-filter](https://github.com/timofurrer/pandoc-plantuml-filter).\n\nThanks [Omar](https://github.com/ram02z) & [Timo](https://github.com/timofurrer)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Pandoc filter for D2 code blocks",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "d2",
        " pandoc-filter",
        " pandoc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9a55057f9f1cc2838b853f531bc396465ad0c57ce6ef7c21427b60e5a22e2ca0",
                "md5": "e789507388bf0fd3ac2ea7a2dbe0ba96",
                "sha256": "54da3a719af05e6c66296ce13417df245181747920fc628fb3eb6121f8c6d46b"
            },
            "downloads": -1,
            "filename": "pandoc_d2_filter-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e789507388bf0fd3ac2ea7a2dbe0ba96",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4031,
            "upload_time": "2024-10-15T15:07:22",
            "upload_time_iso_8601": "2024-10-15T15:07:22.335061Z",
            "url": "https://files.pythonhosted.org/packages/9a/55/057f9f1cc2838b853f531bc396465ad0c57ce6ef7c21427b60e5a22e2ca0/pandoc_d2_filter-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3b5fb4d42a4f58a294dabf8b617dcd3c9bc3482d4d93a624d3afdc40b53fc78",
                "md5": "cc2de6d707319b5be1f54cc0a7339900",
                "sha256": "8bde3b86a32edcc885669aff15addbcd48244ddfb5bdd2578c5ad8b263a1c2b0"
            },
            "downloads": -1,
            "filename": "pandoc_d2_filter-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cc2de6d707319b5be1f54cc0a7339900",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5395,
            "upload_time": "2024-10-15T15:07:23",
            "upload_time_iso_8601": "2024-10-15T15:07:23.626635Z",
            "url": "https://files.pythonhosted.org/packages/a3/b5/fb4d42a4f58a294dabf8b617dcd3c9bc3482d4d93a624d3afdc40b53fc78/pandoc_d2_filter-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-15 15:07:23",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pandoc-d2-filter"
}