{"id":13573579,"url":"https://github.com/fralau/mkdocs-mermaid2-plugin","last_synced_at":"2025-05-15T01:07:32.876Z","repository":{"id":41402035,"uuid":"255874827","full_name":"fralau/mkdocs-mermaid2-plugin","owner":"fralau","description":"A Mermaid graphs plugin for mkdocs","archived":false,"fork":false,"pushed_at":"2024-11-15T07:42:13.000Z","size":1058,"stargazers_count":242,"open_issues_count":12,"forks_count":27,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-14T18:17:52.344Z","etag":null,"topics":["mermaid","mermaid-diagrams","mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://mkdocs-mermaid2.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fralau.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-15T09:55:54.000Z","updated_at":"2025-04-29T22:19:23.000Z","dependencies_parsed_at":"2024-01-16T20:25:22.737Z","dependency_job_id":"a3229588-6578-4f8a-a1d8-53ef647afce7","html_url":"https://github.com/fralau/mkdocs-mermaid2-plugin","commit_stats":{"total_commits":89,"total_committers":16,"mean_commits":5.5625,"dds":0.3370786516853933,"last_synced_commit":"97db6aa8755b340bf8e4526db332e8e288523508"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fralau%2Fmkdocs-mermaid2-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fralau%2Fmkdocs-mermaid2-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fralau%2Fmkdocs-mermaid2-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fralau%2Fmkdocs-mermaid2-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fralau","download_url":"https://codeload.github.com/fralau/mkdocs-mermaid2-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254041,"owners_count":22039792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mermaid","mermaid-diagrams","mkdocs","mkdocs-plugin"],"created_at":"2024-08-01T15:00:37.877Z","updated_at":"2025-05-15T01:07:27.865Z","avatar_url":"https://github.com/fralau.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Mkdocs-Mermaid2\n\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) \n[![PyPI](https://img.shields.io/pypi/v/mkdocs-mermaid2-plugin)](https://pypi.org/project/mkdocs-mermaid2-plugin/)\n![Github](https://img.shields.io/github/v/tag/fralau/mkdocs-mermaid2-plugin?label=github%20tag)\n![Downloads(PyPI)](https://img.shields.io/pypi/dm/mkdocs-mermaid2-plugin)\n\n\nAn [MkDocs](https://www.mkdocs.org/) plugin that renders [Mermaid](https://mermaid-js.github.io/mermaid) text descriptions into diagrams (flow charts, sequence diagrams, pie charts, etc.).\n\n\u003c/div\u003e\n\n---\n\n* **See the [mkdocs-mermaid2 documentation on Read The Docs](https://mkdocs-mermaid2.readthedocs.io).**\n* See the [package on Pypi](https://pypi.org/project/mkdocs-mermaid2-plugin/).\n* View the [general Mkdocs documentation](https://www.mkdocs.org/)\n\n\n\u003e As of version 1.0.0, this plugin works with versions of the Mermaid library \u003e 10,\n\u003e **and** with lower versions.\n\n\n\u003c!-- To update the toc, run the following command:\nmarkdown-toc -i README.md \n--\u003e\n\n\u003c!-- toc --\u003e\n\n- [Mkdocs-Mermaid2](#mkdocs-mermaid2)\n  - [Introduction](#introduction)\n  - [Installation](#installation)\n    - [Automatic](#automatic)\n    - [Manual](#manual)\n    - [Test](#test)\n  - [Configuration](#configuration)\n    - [Basic configuration](#basic-configuration)\n    - [Specifying the version of the Mermaid library](#specifying-the-version-of-the-mermaid-library)\n    - [Additional settings for the Material theme](#additional-settings-for-the-material-theme)\n  - [For more information](#for-more-information)\n\n\u003c!-- tocstop --\u003e\n\n## Introduction\n\nMermaid2 allows you to insert mermaid markup in the markdown \nof your mkdocs pages.\n\nFor example, a markdown page containing the following diagram:\n\n    ```mermaid\n    graph LR\n        hello --\u003e world\n        world --\u003e again\n        again --\u003e hello\n    ```\n\nwill then be displayed in the final HTML page as:\n\n```mermaid\ngraph LR\n    hello --\u003e world\n    world --\u003e again\n    again --\u003e hello\n```\n\nThe diagram will be rendered on the fly by the web browser,\nwith the use of the mermaid javascript library. \nmkdocs-mermaid2 takes care of inserting the javascript library into\nthe html page.\n\n\u003e You can use all the diagrams types supported by the version of the Mermaid \n\u003e javascript library that you are using (flowchart, class, state, timeline, \n\u003e etc.).\n\n\n## Installation\n\n### Automatic\n\n\n```bash\npip install mkdocs-mermaid2-plugin\n```\n\n### Manual\nClone this repository in a local directory and install the package:\n\n```bash\npython setup.py install\n```\n\n### Test\nFor running the examples the `test` directory, \nyou will also need the mkdocs-material theme. You may \n[install it directly](https://squidfunk.github.io/mkdocs-material/getting-started/),\nor use the following command to install the whole package:\n\n```bash\npip install mkdocs-mermaid2-plugin[test]\n```\n\n\n\n\n\n## Configuration\n\n### Basic configuration\nTo enable this plugin, you need to declare it in your [mkdocs config file](https://www.mkdocs.org/user-guide/configuration/)\n(`mkdocs.yml`).\n\nIn order to work, the plugin also requires the\n[mermaid](https://www.npmjs.com/package/mermaid) javascript\nlibrary (in the example below, it fetched from the last version\nfrom the [unpkg](https://unpkg.com/) repository; change the version\nno as needed).\n\n```yaml\nplugins:\n    - search\n    - mermaid2\n```\n\u003e **Note:**  If you declare plugins, you need to declare _all_ of them, \n\u003e including `search` (which would otherwise have been installed by default.)\n\n\n### Specifying the version of the Mermaid library\n\n\nBy default, the plugin selects a version of the Mermaid javascript library\nthat is known to work (some versions work better than others).\n\nYou may specify a different version of the Mermaid library, like so:\n\n```yaml\nplugins:\n  - search\n  - mermaid2:\n      version: 10.0.2\n```\n\nThe plugin will insert the correct call to the javascript library\ninside the final HTML page.\n\n### Additional settings for the Material theme\n\n\n\u003e The [Material theme](https://squidfunk.github.io/mkdocs-material/), \n\u003e developed by [squidfunk](https://github.com/squidfunk)\n\u003e is not mandatory, but recommended.\n\n**Mermaid diagrams will automatically adapt their colors to the theme\nand palette.**\n\nHere are the _additional_ recommended settings in the configuration file:\n\n```yaml\nmarkdown_extensions:\n  - pymdownx.superfences:\n        # make exceptions to highlighting of code:\n      custom_fences:\n        - name: mermaid\n          class: mermaid\n          format: !!python/name:mermaid2.fence_mermaid_custom\n\n```\n\n\u003e Do not use these additional settings for other themes, \n\u003e as diagrams will probably **not** be displayed correctly. \n\n\n## For more information\nSee the [documentation on ReadTheDocs](https://mkdocs-mermaid2.readthedocs.io).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffralau%2Fmkdocs-mermaid2-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffralau%2Fmkdocs-mermaid2-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffralau%2Fmkdocs-mermaid2-plugin/lists"}