Skip to main content

A MkDocs plugin that support mermaid graph

Project description

# mkdocs-markdownextradata-plugin

A MkDocs plugin that render meraid graph to mermaid style


## Installation


Install the package with pip:

```bash
pip install mkdocs-mermaid-plugin
```

## Usage

Enable this plugin in your `mkdocs.yml`:

```yaml
plugins:
- search
- markdownmermaid

extra_javascript:
- https://unpkg.com/mermaid@7.1.2/dist/mermaid.min.js
```

> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.

> **Note:** Don't forget to include the mermaid.min.js (local or remotely) in your `mkdocs.yml`

More information about plugins in the [MkDocs documentation][mkdocs-plugins]



[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-mermaid-plugin-0.0.2.tar.gz (2.1 kB view details)

Uploaded Source

Built Distribution

mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl (3.5 kB view details)

Uploaded Python 2

File details

Details for the file mkdocs-mermaid-plugin-0.0.2.tar.gz.

File metadata

  • Download URL: mkdocs-mermaid-plugin-0.0.2.tar.gz
  • Upload date:
  • Size: 2.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

File hashes

Hashes for mkdocs-mermaid-plugin-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d436c83ff86ae9f1f9ba49344154dd6db36ebd21d85ccd073e24c0df75be67c0
MD5 989723fb64d10f19da4cabc511018434
BLAKE2b-256 8076d5407d8120cb5e6532b099c06d57e69259ffbb0e06369c53ddd014707c4a

See more details on using hashes here.

File details

Details for the file mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl.

File metadata

  • Download URL: mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15

File hashes

Hashes for mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 177f05c3e5e86cce98cbf6313b0c1ab9ccfdb546a6b4cacef570a3afb240774d
MD5 8e83c0a03cb94eca5581292009fe2454
BLAKE2b-256 11edbe8cedac1da81a7e1acad8b0ce42105949d0aef9a7c97d6aa23ba828c60c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page