Skip to content

Add flowcharts and diagrams to Dokuwiki with an incredibly simple syntax

License

Notifications You must be signed in to change notification settings

Vitamin-X/dokuwiki-plugin-flowcharts

 
 

Repository files navigation

Flowcharts Plugin for DokuWiki

Add flowcharts and diagrams to Dokuwiki with an intuitive syntax

The diagrams and flowcharts are generated with https://mermaidjs.github.io/.

With the current version of the plugin it is crucial to remove the following lines from the Dokuwiki file conf/entities.conf

<->     ↔
->      →
<-      ←
---     —
--      –

Otherwise, Dokuwiki will render -> to → and then the diagrams are not rendered correctly since, e.g. → is the wrong syntax and we need -> etc. (For more information, see https://www.dokuwiki.org/entities and also https://github.com/splitbrain/dokuwiki/blob/master/conf/entities.conf.)

Syntax

<flow>
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
</flow>

will be rendered to

example diagram

A nice feature is that each element of a diagram can be made clickable by using

<flow>
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;    
click A "SOMEPAGE"
</flow>

Clicking on A will take you to http://yoururl.com/SOMEPAGE.

For further details on the syntax, see https://mermaidjs.github.io/. Diagrams can be built in realtime using https://mermaidjs.github.io/mermaid-live-editor/.

If you install this plugin manually, make sure it is installed in lib/plugins/mermaidflowcharts/ - if the folder is called different it will not work!

Please refer to http://www.dokuwiki.org/plugins for additional info on how to install plugins in DokuWiki.


Plugin by Jakob Schwichtenberg http://jakobschwichtenberg.com

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See the LICENSING file for details

About

Add flowcharts and diagrams to Dokuwiki with an incredibly simple syntax

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 99.6%
  • CSS 0.4%