{"id":13675575,"url":"https://github.com/backmarket-oss/github-mermaid-extension","last_synced_at":"2025-04-28T23:30:55.486Z","repository":{"id":133044648,"uuid":"183229799","full_name":"backmarket-oss/github-mermaid-extension","owner":"backmarket-oss","description":"A browser extension for Chrome, Opera \u0026 Firefox that adds Mermaid language support to Github","archived":true,"fork":false,"pushed_at":"2021-10-18T21:20:18.000Z","size":8722,"stargazers_count":239,"open_issues_count":26,"forks_count":65,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-23T16:02:11.086Z","etag":null,"topics":["chrome","chrome-extension","extension","firefox","firefox-extension","github","mermaid","webextension"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/backmarket-oss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-04-24T13:00:43.000Z","updated_at":"2025-04-08T23:33:23.000Z","dependencies_parsed_at":"2023-04-12T08:47:22.362Z","dependency_job_id":null,"html_url":"https://github.com/backmarket-oss/github-mermaid-extension","commit_stats":null,"previous_names":["backmarket-oss/github-mermaid-extension","backmarket/github-mermaid-extension"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backmarket-oss%2Fgithub-mermaid-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backmarket-oss%2Fgithub-mermaid-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backmarket-oss%2Fgithub-mermaid-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backmarket-oss%2Fgithub-mermaid-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/backmarket-oss","download_url":"https://codeload.github.com/backmarket-oss/github-mermaid-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251404435,"owners_count":21584092,"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":["chrome","chrome-extension","extension","firefox","firefox-extension","github","mermaid","webextension"],"created_at":"2024-08-02T12:00:46.267Z","updated_at":"2025-04-28T23:30:50.470Z","avatar_url":"https://github.com/backmarket-oss.png","language":"JavaScript","funding_links":[],"categories":["Prerequisites"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\n    Github + Mermaid  \n  \u003c/h1\u003e\n\n  \u003cp\u003e\n    \u003cstrong\u003e\n      A browser extension for Chrome, Opera \u0026 Firefox that adds\n      \u003cimg src=\"https://mermaidjs.github.io/gitbook/images/favicon.ico\" width=\"16\" height=\"16\"/\u003e\n      \u003ca href=\"https://mermaidjs.github.io\" target=\"_blank\"\u003eMermaid\u003c/a\u003e\n      language support to\n      \u003cimg src=\"https://github.githubassets.com/favicon.ico\" width=\"16\" height=\"16\"/\u003e\n      \u003ca href=\"https://guides.github.com/features/mastering-markdown/\" target=\"_blank\"\u003eGithub Markdown\u003c/a\u003e.\n    \u003c/strong\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./resources/chrome-promo/marquee.png\" alt=\"Extension Boilerplate\"/\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"#install\"\u003eInstall\u003c/a\u003e •\n    \u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e •\n    \u003ca href=\"#how-to-use\"\u003eHow to use\u003c/a\u003e •\n    \u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e •\n    \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e •\n    \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\n  \u003c/p\u003e\n\n  \u003cp class=\"center\"\u003e\n    \u003ca href=\"https://travis-ci.com/BackMarket/github-mermaid-extension\" target=\"_blank\"\u003e\n      \u003cimg src=\"https://travis-ci.com/BackMarket/github-mermaid-extension.svg?branch=master\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://david-dm.org/BackMarket/github-mermaid-extension\"\u003e\n      \u003cimg src=\"https://img.shields.io/david/BackMarket/github-mermaid-extension.svg\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://david-dm.org/BackMarket/github-mermaid-extension#info=devDependencies\"\u003e\n      \u003cimg src=\"https://img.shields.io/david/dev/BackMarket/github-mermaid-extension.svg\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://greenkeeper.io/\"\u003e\n      \u003cimg src=\"https://badges.greenkeeper.io/BackMarket/github-mermaid-extension.svg\"/\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n## Install\n\n- \u003cimg height=\"16\" src=\"./resources/icons/chrome.svg\"\u003e **Google Chrome**: [GitHub + Mermaid - Chrome Web Store](https://chrome.google.com/webstore/detail/github-%20-mermaid/goiiopgdnkogdbjmncgedmgpoajilohe)\n- \u003cimg height=\"16\" src=\"./resources/icons/firefox.svg\"\u003e **Firefox**: [GitHub + Mermaid - Firefox Add-ons](https://addons.mozilla.org/en-GB/firefox/addon/github-mermaid/)\n- \u003cimg height=\"16\" src=\"./resources/icons/opera.svg\"\u003e **Opera**: coming later\n\n## Features\n\n### Supported GitHub features\n\n- [x] Pull requests \u0026 issues description (preview + published) - [Demo](https://github.com/BackMarket/github-mermaid-extension/issues/1)\n- [x] Pull requests \u0026 issues comment (preview + published)\n- [x] Markdown (`.md`) files (diff + published)\n- [x] Gists - [Demo](https://gist.github.com/amercier/df2e07a994315d323e398120bdda3989)\n\n### Diagram types\n\n#### Flowcharts\n\n![Flowchart example](/resources/screenshots/flowchart.png)\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow source code\u003c/summary\u003e\n\n  ```\n  ```mermaid\n  graph LR\n\n  A(Start)\n\n  A --\u003e B[Look for an item]\n\n  B --\u003e C{Did you find it?}\n  C --\u003e|Yes| D(Stop looking)\n  C --\u003e|No| E{Do you need it?}\n  E --\u003e|Yes| B\n  E --\u003e|No| D\n  ```\n\u003c/details\u003e\n\n#### Sequence Diagrams\n\n![Sequence Diagram example](/resources/screenshots/sequence-diagram.png)\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow source code\u003c/summary\u003e\n\n  ```\n  ```mermaid\n  sequenceDiagram\n  participant U as User\n  participant C as Client\n  participant S as Server\n  participant DB as Database\n\n  U -\u003e\u003e C: Fill username\n  U -\u003e\u003e C: Fill password\n  C -\u003e\u003e U: Enable \"Login\" button\n  U -\u003e\u003e C: Click \"Login\" button\n  C -\u003e\u003e+ S: POST /login\n  S -\u003e\u003e+ DB: SELECT FROM users\n  Note over S,DB: See login.py for impl. details\n  DB --\u003e\u003e- S: results\n  S --\u003e\u003e- C: { authenticated: true }\n  C -\u003e\u003e U: redirect /home\n  ```\n\u003c/details\u003e\n\n#### Gantt Diagrams\n\n![Gantt Diagram example](/resources/screenshots/gantt-diagram.png)\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow source code\u003c/summary\u003e\n\n  ```\n  ```mermaid\n  gantt\n      title A Gantt Diagram\n      dateFormat  YYYY-MM-DD\n      section Section\n      A task           :a1, 2014-01-01, 30d\n      Another task     :after a1  , 20d\n      section Another\n      Task in sec      :2014-01-12  , 12d\n      another task      : 24d\n  ```\n\u003c/details\u003e\n\n## How to use\n\nSimply put Mermaid code into \u003ccode\u003e```mermaid\u003c/code\u003e. See\n[Mermaid official website](https://mermaidjs.github.io/gantt.html) for more\ninformation about the Mermaid syntax.\n\n## Roadmap\n\n- [x] Initial implementation\n- [x] Publish Chrome extension\n- [x] Documentation\n- [x] Publish Firefox extension\n- [ ] Publish Opera extension\n- [x] Continuous Integration\n- [x] Upgrade dependencies\n- [x] Automatic dependency management\n- [x] Fix #3\n- [ ] Testing\n- [ ] Dark theme + option page\n- [ ] Cleanup\n\n## License\n\n[![License](https://img.shields.io/github/license/BackMarket/github-mermaid-extension.svg)](/LICENSE.md)\n\n## Contributing\n\nContributions (issues ♥, pull requests ♥♥♥) are more than welcome! Feel free to clone, fork, modify, extend, etc.\n\nSee [contributing intructions](/CONTRIBUTING.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackmarket-oss%2Fgithub-mermaid-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackmarket-oss%2Fgithub-mermaid-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackmarket-oss%2Fgithub-mermaid-extension/lists"}