A MkDocs plugin that support mermaid graph
Project description
# mkdocs-markdownextradata-plugin
*A MkDocs plugin that render meraid graph to mermaid style
<br/>
## Installation
> **Note:** This package requires MkDocs version 0.17 or higher.
Install the package with pip:
```bash
pip install mkdocs-mermaid-plugin
```
Enable the plugin in your `mkdocs.yml`:
```yaml
plugins:
- search
- markdownmermaid
```
> **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.
More information about plugins in the [MkDocs documentation][mkdocs-plugins]
<br/>
*A MkDocs plugin that render meraid graph to mermaid style
<br/>
## Installation
> **Note:** This package requires MkDocs version 0.17 or higher.
Install the package with pip:
```bash
pip install mkdocs-mermaid-plugin
```
Enable the plugin in your `mkdocs.yml`:
```yaml
plugins:
- search
- markdownmermaid
```
> **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.
More information about plugins in the [MkDocs documentation][mkdocs-plugins]
<br/>
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
Built Distributions
Close
Hashes for mkdocs-mermaid-plugin-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9ee7939cd77715dc523c5a7d6c964701379c8475b5d36a3c759638d4fa4e771 |
|
MD5 | e3644bd6d7c4836a5e28d57ee0acc371 |
|
BLAKE2b-256 | 3bc4062a0af3941cccd69c90a23ad04c642fca462a7ba35e4b06100368c02016 |
Close
Hashes for mkdocs_mermaid_plugin-0.0.1-py2.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e122a216c4362227cc8eeefa390090fd71ab7ebecb67a472ceba92528257274 |
|
MD5 | 217ebf582c5500d565f966ead10ad1cc |
|
BLAKE2b-256 | c4de450270c977c245b812f88cdbb533e0c3cd4b955617003f156539c22ddd4a |
Close
Hashes for mkdocs_mermaid_plugin-0.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb0a5c1b2680a2771f4f806818452ccaa27cc67ee8badf53df5b5e58e5fc3422 |
|
MD5 | 3d1c31cbe2fe28081701894f65a65914 |
|
BLAKE2b-256 | bacece3903e2516baf2faf34c53d36e7b95ffdd51aed1521f2a9866cf16b5ccd |