Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

Support of mermaid blocks in .md files #61

Open
shpak-cvl opened this issue Sep 25, 2020 · 0 comments
Open

Support of mermaid blocks in .md files #61

shpak-cvl opened this issue Sep 25, 2020 · 0 comments

Comments

@shpak-cvl
Copy link

I've noticed an issue when trying to convert a .md file with mermaid code.
Mermaid is widely used in Markdown file and works well. Also mermaid support already added to Sphinx using the sphinxcontrib-mermaid plugin. Mermaid markup in a .rst file is look as below:

.. mermaid::

   sequenceDiagram
      participant Alice
      participant Bob
      Alice->John: Hello John, how are you?
      loop Healthcheck
          John->John: Fight against hypochondria
      end
      Note right of John: Rational thoughts <br/>prevail...
      John-->Alice: Great!
      John->Bob: How about you?
      Bob-->John: Jolly good!

But seems during composing the documentation from a .md file Sphinx not able to recognize mermaid markup because M2R converted 1st line of mermaid block not into .. mermaid:: string but into .. code-block:: mermaid string.
Could you please add conversion of mermaid block not as code-block but as separate and specific code?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant