https://github.com/gisce/markdown-blockdiag

blockdiag extension for Python Markdown
https://github.com/gisce/markdown-blockdiag

blockdiag diagram documentation hacktoberfest markdown mkdocs

Last synced: about 1 month ago
JSON representation

blockdiag extension for Python Markdown

• Host: GitHub
• URL: https://github.com/gisce/markdown-blockdiag
• Owner: gisce
• License: mit
• Created: 2017-01-18T15:27:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-22T10:28:44.000Z (12 months ago)
• Last Synced: 2024-04-24T15:23:57.507Z (7 months ago)
• Topics: blockdiag, diagram, documentation, hacktoberfest, markdown, mkdocs
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 26
• Watchers: 24
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Markdown blockdiag

==================

.. image:: https://travis-ci.org/gisce/markdown-blockdiag.svg?branch=master

    :target: https://travis-ci.org/gisce/markdown-blockdiag

This is the `blockdiag `_

extension for `Python Markdown `_

Install

-------

.. code-block::

  $ pip install markdown-blockdiag

Use

---

In your markdown text you can define the block

.. code-block::

  blockdiag {

      A -> B -> C -> D;

      A -> E -> F -> G;

  }

Testing

-------

.. code-block::

  $ pip install coverage

  $ python setup.py test

MkDocs Integration

------------------

In your mkdocs.yml add this to markdown_extensions.

.. code-block::

  markdown_extensions:

    - markdown_blockdiag:

        format: svg