Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added mermaid support as an extra module #83

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

knsv
Copy link

@knsv knsv commented Jun 29, 2015

Thanks for a good documentation system! A very good blend between flexibility, simplicity and structure. I am looking at using docker in some projects but as I like to have mermaid for graphs in the dokumentation I decided to add that.

This pull request is based on pull request #79 and uses marked to generate the mermaid code. In order to keep things simple I added the mermaid files in the extras hierarchy.

One might consider adding a build step to get fetch the extras from npm instead of having them checked in into the repository.

@knsv
Copy link
Author

knsv commented Jun 29, 2015

I also added a fix for the headings panel as that functionality must have broken in the switch to marked. I realize there are probably more code that could be removed but leave that for later commits... :)

@alinex
Copy link
Contributor

alinex commented Jul 31, 2016

I won't change the tripple back quotes syntax for this because it should be used to highlight code, so in my meaning your syntax should highlight the mermaid syntax. To overcome this I added the alternative block with three dollar signs and an implementation name to execute the code within.

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

Successfully merging this pull request may close these issues.

3 participants