Mermaid Diagrams extension for phpBB

  • 2 min read

Mermaid Diagrams extension for phpBB.

Build Status Latest Stable Version Code Quality License

Allows you to generate diagrams and flowcharts from text in a similar manner as markdown.

It uses the mermaid library to generate the SVG markup and supports all diagrams available. You can read more about the supported syntax in the official documentation:

Features

  • Posting button for the [mermaid] BBCode
  • Generate SVG diagrams from text
  • Supports all diagrams and charts available in the library, currently:
    • Flowchart
    • Sequence diagram
    • Class diagram
    • State diagram
    • Gantt diagram
    • Git graph
    • Pie chart
  • Compatible with Markdown extension
  • It doesn’t require extra configuration

Preview

Flowchart Sequence diagram Gantt diagram Class diagram State diagram Pie chart

(Click to view in full size)

Requirements

  • PHP 5.6 or greater
  • phpBB 3.2 or greater

Support

If you like or found this extensions useful and want to show some appreciation, you can consider donating.

PayPal Donate

Installation

  • Download the latest release
  • Decompress the *.zip or *.tar.gz file
  • Copy the files and directories inside {PHPBB_ROOT}/ext/alfredoramos/mermaid/
  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Enable and confirm

Configuration

It doesn’t require any configuration.

Uninstallation

  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Disable and confirm
  • Go back to Manage extensions > Mermaid Diagrams > Delete data and confirm

Upgrade

  • Uninstall the extension
  • Delete all the files inside {PHPBB_ROOT}/ext/alfredoramos/mermaid/
  • Download the new version
  • Install the extension