flowchart

[VinzentE]

I love the idea behind MkDocsPlus - I was thinking about a similar approach for several months until I found this one!

Two issues / questions considering flowchart.

1. would it be possible to write the logic right within the md file like it is shown here https://adrai.github.io/flowchart.js/ and not within the data.js? That might make it a lot easier to work with
2. with the default theme it shows me only one flowchart but not both. Only when I switch themes e.g. to "readthedocs" it shows both.

Looking forward to you help.

One more thing:
Any idea if integrating leafletJs is a "simple task"? That would be fantastic as we could then finally integrated interactive images / maps to our documentation

Thanks
Vinz

[bwmarrin]

I'll look into these as soon as I get a chance (read: might be a couple days) but it all sounds possible. If you can toy around with it and find a solution PR's are always welcome too.

[bwmarrin]

Okay, so I've got time to work on this.

1. The flowchart.js website doesn't ever demonstrate embedding the chart data directly into a markdown file. However MkDocsPlus is actually doing that now. There are two charts that are displayed and one is created using a jquery-plugin.js to parse the embeded chart data inside the markdown file and the other is created using the data.js method. I even submitted a github issue to the flowchart.js project on this topic which can be seen here Allow storing the flowchart data/code inside a div element. adrai/flowchart.js#54

2. I'll have to test that. I'm updating the example with latest versions of everything first and then we'll go from there.

3. Yeah I'll check out leafletjs after flowchart #2.

[bwmarrin]

Okay, for issue 2. This is because MkDocs includes jquery after the page content with it's own theme and all of the bootstrap themes. The readthedocs theme however includes jquery before the page content.

Because of this, jquery doesn't exist at the point that the the jquery-plugin.js code is executed. That causes the plugin to not work. To fix this you would need to make a custom theme for mkdocs based on the normal mkdocs theme and modify it so that jquery is loaded prior to the page content being loaded.

Another option is to possibly include the required javascript for the example in the extra_javascript setting in mkdocs config but I think that would cause that javascript to get loaded for every page and I wanted to keep each example separated entirely.

I'm not sure if this is something the MkDocs team would consider changing or not but it could be worth making an issue on the MkDocs github page and asking because many of the examples in MkDocsPlus require jquery to be loaded already. (@waylan @d0ugal)

[bwmarrin]

Also, I've updated the entire flowchart.js example now to be much more clear about what it's doing and also jumped to the latest versions of flowchart and raphael js.

[waylan]

MkDocs includes jquery after the page content with it's own theme and all of the bootstrap themes. The readthedocs theme however includes jquery before the page content.

I've been annoyed by this myself. I would suggest opening an issue on the MkDocs project.