{"id":13473754,"url":"https://github.com/Jellyvision/jsdoc-mermaid","last_synced_at":"2025-03-26T19:34:42.374Z","repository":{"id":71242889,"uuid":"105290241","full_name":"Jellyvision/jsdoc-mermaid","owner":"Jellyvision","description":"A tool to automagically create flowcharts and diagrams in your jsdocs.","archived":false,"fork":false,"pushed_at":"2020-04-23T13:31:39.000Z","size":8,"stargazers_count":56,"open_issues_count":4,"forks_count":12,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-10-30T06:33:28.355Z","etag":null,"topics":["apis","diagram","docs","documentation","flowchart","javascript","jsdoc","jsdoc-mermaid","mermaid"],"latest_commit_sha":null,"homepage":null,"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/Jellyvision.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-09-29T15:48:45.000Z","updated_at":"2024-10-19T11:53:49.000Z","dependencies_parsed_at":"2023-03-11T10:08:11.779Z","dependency_job_id":null,"html_url":"https://github.com/Jellyvision/jsdoc-mermaid","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jellyvision%2Fjsdoc-mermaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jellyvision%2Fjsdoc-mermaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jellyvision%2Fjsdoc-mermaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jellyvision%2Fjsdoc-mermaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jellyvision","download_url":"https://codeload.github.com/Jellyvision/jsdoc-mermaid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245722918,"owners_count":20661849,"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":["apis","diagram","docs","documentation","flowchart","javascript","jsdoc","jsdoc-mermaid","mermaid"],"created_at":"2024-07-31T16:01:06.561Z","updated_at":"2025-03-26T19:34:39.836Z","avatar_url":"https://github.com/Jellyvision.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# jsdoc-mermaid\n\nA plugin that parses your JSDocs for [Mermaid](https://mermaidjs.github.io/) syntax and renders the diagrams and flowcharts described.\n\n## Getting Started\n\n```bash\n# install as a local dependency\nyarn add -D jsdoc-mermaid # OR npm install -D jsdoc-mermaid\n```\n\nAnd then add `jsdoc-mermaid` to your jsdoc configuration file. That's it!\n\n```javascript\n{\n    \"plugins\": [\"jsdoc-mermaid\"]\n}\n```\n\n## Usage\n\nDocument a method with an `@mermaid` tag using JSDoc Syntax, like so:\n\n```javascript\n/**\n * Represents a book.\n * @constructor\n * @param {string} title - The title of the book.\n * @param {string} author - The author of the book.\n *\n * @mermaid\n *   graph TD;\n *     A--\u003eB;\n *     A--\u003eC;\n *     B--\u003eD;\n *     C--\u003eD;\n */\nfunction Book(title, author) {\n  /* ... */\n}\n```\n\nGenerate your JSDocs using the [configuration](http://usejsdoc.org/about-configuring-jsdoc.html) you've specified - for instance:\n```bash\njsdoc book.js -c conf.json \n```\n\nWhen you open that page in JSDoc, you should have a shiny new graph!\n\n![jsdoc-mermaid example](https://user-images.githubusercontent.com/2096353/31104126-b9159786-a7a0-11e7-95ed-689a7f158803.png)\n\n\n## Built With\n\n* [Mermaid](https://github.com/knsv/mermaid) - Generation of diagram and flowchart from text in a similar manner as markdown\n* [Doctrine](https://github.com/eslint/doctrine) - JSDoc parser\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJellyvision%2Fjsdoc-mermaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJellyvision%2Fjsdoc-mermaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJellyvision%2Fjsdoc-mermaid/lists"}