{"id":16445687,"url":"https://github.com/doreapp/sphinx-mermaid","last_synced_at":"2025-08-22T02:06:17.265Z","repository":{"id":63812680,"uuid":"570894568","full_name":"Doreapp/sphinx-mermaid","owner":"Doreapp","description":"Mermaid graph support for sphinx generated documentations","archived":false,"fork":false,"pushed_at":"2023-01-02T13:05:31.000Z","size":2878,"stargazers_count":7,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-22T02:03:29.022Z","etag":null,"topics":["diagram","mermaid","mermaid-diagrams","mermaidjs","python","restructuredtext","rst","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://doreapp.github.io/sphinx-mermaid/","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/Doreapp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-26T13:32:19.000Z","updated_at":"2024-06-21T21:16:20.000Z","dependencies_parsed_at":"2023-02-01T02:45:30.753Z","dependency_job_id":null,"html_url":"https://github.com/Doreapp/sphinx-mermaid","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Doreapp/sphinx-mermaid","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doreapp%2Fsphinx-mermaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doreapp%2Fsphinx-mermaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doreapp%2Fsphinx-mermaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doreapp%2Fsphinx-mermaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Doreapp","download_url":"https://codeload.github.com/Doreapp/sphinx-mermaid/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doreapp%2Fsphinx-mermaid/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271574431,"owners_count":24783319,"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","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["diagram","mermaid","mermaid-diagrams","mermaidjs","python","restructuredtext","rst","sphinx","sphinx-extension"],"created_at":"2024-10-11T09:45:03.415Z","updated_at":"2025-08-22T02:06:17.225Z","avatar_url":"https://github.com/Doreapp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mermaid support for Sphinx documentation\n\n[Mermaid graphs](https://mermaid-js.github.io/mermaid/#/) support for [sphinx generated documentations](https://www.sphinx-doc.org/en/master/).\n\n- [GitHub repository at Doreapp/sphinx-mermaid](https://github.com/Doreapp/sphinx-mermaid/)\n- [Pypi package sphinx-mermaid](https://pypi.org/project/sphinx-mermaid/)\n- Example of usage: [GitHub pages of this repo](https://doreapp.github.io/sphinx-mermaid/)\n\n## Install\n\n```bash\npip install sphinx-mermaid\n```\n\n## Setup in `conf.py`\n\nIn the `conf.py` file of your documentation, add the extension:\n\n```python\nextensions = [\n    ...,\n    'sphinxmermaid'\n]\n```\n\n### Config Options\n\n`sphinxmermaid_mermaid_init` can be set as a dictionary of values.\n\nThese will be passed to `mermaid.initialize()`. Find more info at\n[MermaidJS](https://mermaid.js.org/intro/n00b-syntaxReference.html)\n\nExample:\n\n```python\nsphinxmermaid_mermaid_init = {\n  'theme': 'base',\n  'themeVariables': {\n    'primaryColor': '#BB2528',\n    'primaryTextColor': '#fff',\n    'primaryBorderColor': '#7C0000',\n    'lineColor': '#F8B229',\n    'secondaryColor': '#006100',\n    'tertiaryColor': '#fff'\n  }\n}\n```\n\n## Usage\n\nIn your `rst` (or `md`) files, use the directive just like:\n\n```rst\n.. mermaid ::\n\n    graph TD\n    A --\u003e B\n    B -- Label --\u003e C\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoreapp%2Fsphinx-mermaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoreapp%2Fsphinx-mermaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoreapp%2Fsphinx-mermaid/lists"}