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/
Metadata
Release files for mkdocs-mermaid-plugin 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-mermaid-plugin-0.0.2.tar.gz | 2.1 kB | Without provenance | Details for mkdocs-mermaid-plugin-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl | Python 2 | none | any | Details for mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl |
Total release size: 5.6 kB
Release files / mkdocs-mermaid-plugin-0.0.2.tar.gz
| Download URL | mkdocs-mermaid-plugin-0.0.2.tar.gz |
|---|---|
| Size | 2.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d436c83ff86ae9f1f9ba49344154dd6db36ebd21d85ccd073e24c0df75be67c0
|
|
BLAKE2b-256 checksum How to use checksums |
8076d5407d8120cb5e6532b099c06d57e69259ffbb0e06369c53ddd014707c4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl
| Download URL | mkdocs_mermaid_plugin-0.0.2-py2-none-any.whl |
|---|---|
| Size | 3.5 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
177f05c3e5e86cce98cbf6313b0c1ab9ccfdb546a6b4cacef570a3afb240774d
|
|
BLAKE2b-256 checksum How to use checksums |
11edbe8cedac1da81a7e1acad8b0ce42105949d0aef9a7c97d6aa23ba828c60c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for mkdocs-mermaid-plugin 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.