Skip to main content

Inline blockdiag images for Markdown with SuperFences

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.3.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

blockdiag_fences-0.0.3-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file blockdiag-fences-0.0.3.tar.gz.

File metadata

  • Download URL: blockdiag-fences-0.0.3.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.8.10 Linux/5.10.60.1-microsoft-standard-WSL2

File hashes

Hashes for blockdiag-fences-0.0.3.tar.gz
Algorithm Hash digest
SHA256 d5eb9374b8bb5aa7251a94a02633c9eef29f7e3e60a6ccb32691a9c6a1298e05
MD5 4e6de04fc55173c870e15f33932ff810
BLAKE2b-256 ab346958b25d41bfebe6bf4b64712b85096764790522664ce698f31f4d36b23d

See more details on using hashes here.

File details

Details for the file blockdiag_fences-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: blockdiag_fences-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.8.10 Linux/5.10.60.1-microsoft-standard-WSL2

File hashes

Hashes for blockdiag_fences-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 61b7f3567d9b22748aee358d6c198f7248a4370b5f66032c7d94f19e938b7b6f
MD5 467a79fb5699ee073a7e0e16b84e6df8
BLAKE2b-256 174f414e755b28df90a67f09424620e044552c10a5132543b34ec86ad85ab39f

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