Skip to content

6cdh/SimpleMermaid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SimpleMermaid

The SimpleMermaid extension enables mermaid between <mermaid> and </mermaid>.

Features

  • Client-side rendering
  • Simple (less than 100 LOC)
  • Usable at preview page
  • Full mermaid support
  • Better error report

Install

  1. Clone into your extension directory
git clone https://github.com/6cdh/SimpleMermaid.git SimpleMermaid
  1. Enable extension in LocalSettings.php
wfLoadExtension( 'SimpleMermaid' );

Example

<mermaid>
flowchart LR
    Start --> Stop
</mermaid>

The example above will be expanded as

<div class="mermaid">
flowchart LR
    Start --> Stop
</div>

Then processed by mermaid.

Settings

# $setting_name = default_value # Available values

# mermaid theme
$wgSimpleMermaidTheme = 'default' # 'default' | 'base' | 'forest' | 'neutral'

Thanks

About

A mediawiki extension for client-side rendering mermaid

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published