https://github.com/ram02z/d2-filter
Pandoc filter for D2
https://github.com/ram02z/d2-filter
d2 pandoc pandoc-filter
Last synced: 4 months ago
JSON representation
Pandoc filter for D2
- Host: GitHub
- URL: https://github.com/ram02z/d2-filter
- Owner: ram02z
- License: mit
- Created: 2023-04-06T16:05:01.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T09:00:14.000Z (almost 2 years ago)
- Last Synced: 2025-10-30T12:57:18.313Z (8 months ago)
- Topics: d2, pandoc, pandoc-filter
- Language: TypeScript
- Homepage:
- Size: 86.9 KB
- Stars: 20
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# d2-filter
`d2-filter` is a pandoc filter that adds [D2](https://d2lang.com) syntax
diagrams in markdown documents.
## Example
```
~~~{.d2 pad=20}
x -> y
~~~
```
## Usage
```bash
# Installation
npm i -g d2-filter
# Unix
pandoc -F d2-filter test.md -o test.pdf
# Windows
pandoc -F d2-filter.cmd test.md -o test.pdf
```
If using with [Quarto](https://quarto.org/), you can use [quarto-d2](https://github.com/data-intuitive/quarto-d2) to avoid issues with pandoc filters.
## Configuration
Using attributes of the fenced code block, you can specify:
- Theme
- Example: `{.d2 theme="Grape soda"}`.
- Default: `0` or `Neutral default`
- Values: Run `d2 themes` for possible options.
- Layout engine
- Example: `{.d2 layout=elk}`.
- Default: `dagre`
- Values: Run `d2 layout` for possible options.
- Image format
- Example: `{.d2 format=png}`
- Default: `svg`
- Values: `svg`, `png`, `pdf`
- Sketch
- Example: `{.d2 sketch=true}`
- Default: `false`
- Image padding
- Example: `{.d2 pad=0}`
- Default: `100`
- Folder
- Example: `{.d2 folder=img}`
- Default: no folder as image is encoded to data URI on `img` tag
- Filename
- Example: `{.d2 filename="test"}`
- Default: `diagram-N`
- `folder` attribute is required to save file locally
- Pandoc caption
- Example: `{.d2 caption="This is a test image"}`
- Default: empty string
- Pandoc image attributes
- Example: `{.d2 width=30 height=20px}`
- Default: empty array
- Values: See pandoc's [`link_attributes`](https://pandoc.org/MANUAL.html#extension-link_attributes) extension
- Note that `#id` and `.class` attributes are not supported, but any
key-value attributes should work
## Credits
- [mermaid-filter](https://github.com/raghur/mermaid-filter)
- [mathjax-pandoc-filter](https://github.com/lierdakil/mathjax-pandoc-filter)
## License
MIT