Skip to main content

blockdiag extension for Python Markdown

Project description

blockdiag for SuperFences

This provides blockdiag rendering for Python Markdown through the SuperFences extension.

It is based on https://github.com/gisce/markdown-blockdiag.

Install

pip install blockdiag-fences

Use

Wrap your diagram in a code block, tagged with the name of the tool to convert it:

```blockdiag
blockdiag {
	A -> B -> C -> D;
	A -> E -> F -> G;
}
```

MkDocs Integration

In your mkdocs.yml add this to markdown_extensions.

markdown_extensions:
  - pymdownx.superfences:
    custom_fences:
      - name: actdiag
        class: actdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: blockdiag
        class: blockdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: nwdiag
        class: nwdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: packetdiag
        class: packetdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: rackdiag
        class: rackdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: seqdiag
        class: seqdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format

Project details


Download files

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

Source Distribution

blockdiag-fences-0.0.2.tar.gz (2.6 kB view hashes)

Uploaded Source

Built Distribution

blockdiag_fences-0.0.2-py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 3

Supported by

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