Skip to content

AlfredoRamos/phpbb-ext-mermaid

Repository files navigation

About

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
    • Entity relationship diagram
    • State diagram
    • Gantt diagram
    • Git graph
    • Pie chart
  • Compatible with Markdown extension
  • It doesn't require extra configuration

Requirements

  • PHP 7.1.3 or greater
  • phpBB 3.3 or greater

Support

Donate

If you like or found my work useful and want to show some appreciation, you can consider supporting its development by giving a donation.

Donate with PayPal Donate with Stripe
Donate with PayPal Donate with Stripe

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

Preview

Flowchart Sequence diagram Gantt diagram Class diagram Entity relationship diagram State diagram Pie chart

(Click to view in full size)

Configuration

It doesn't require extra 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

  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Disable and confirm
  • Delete all the files inside {PHPBB_ROOT}/ext/alfredoramos/mermaid/
  • Download the new version
  • Upload the new files inside {PHPBB_ROOT}/ext/alfredoramos/mermaid/
  • Enable the extension again

Credits

File load-balancer.svg from Zoondicons by Steve Schoger is licensed under CC BY 4.0