{"id":17104606,"url":"https://github.com/imyelo/docsify-plantuml","last_synced_at":"2025-04-04T20:07:36.551Z","repository":{"id":39344743,"uuid":"100380340","full_name":"imyelo/docsify-plantuml","owner":"imyelo","description":"PlantUML plugin for docsify","archived":false,"fork":false,"pushed_at":"2024-11-10T01:36:00.000Z","size":664,"stargazers_count":70,"open_issues_count":6,"forks_count":17,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T19:07:40.016Z","etag":null,"topics":["docsify","plantuml"],"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/imyelo.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-15T13:30:52.000Z","updated_at":"2025-02-27T08:44:04.000Z","dependencies_parsed_at":"2023-01-24T01:45:28.149Z","dependency_job_id":"e7a392fe-c839-46aa-8945-c234362619b7","html_url":"https://github.com/imyelo/docsify-plantuml","commit_stats":{"total_commits":58,"total_committers":5,"mean_commits":11.6,"dds":"0.43103448275862066","last_synced_commit":"dbfe289bcee7f05fc032c8237ffd73577b3dc59b"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imyelo%2Fdocsify-plantuml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imyelo%2Fdocsify-plantuml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imyelo%2Fdocsify-plantuml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imyelo%2Fdocsify-plantuml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imyelo","download_url":"https://codeload.github.com/imyelo/docsify-plantuml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242671,"owners_count":20907133,"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":["docsify","plantuml"],"created_at":"2024-10-14T15:37:27.455Z","updated_at":"2025-04-04T20:07:36.519Z","avatar_url":"https://github.com/imyelo.png","language":"JavaScript","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# docsify-plantuml\n[![npm](https://img.shields.io/npm/v/docsify-plantuml.svg?style=flat-square)](https://www.npmjs.com/package/docsify-plantuml)\n\n## Install\n1. Configure docsify-plantuml (optional):\n\n    ```html\n    \u003cscript\u003e\n    window.$docsify = {\n      plantuml: {\n        skin: 'default',\n      },\n    }\n    \u003c/script\u003e\n    ```\n    \n    See [Options](#Options) for more details.\n\n2. Insert script into docsify document:\n\n    ```html\n    \u003cscript src=\"//unpkg.com/docsify-plantuml/dist/docsify-plantuml.min.js\"\u003e\u003c/script\u003e\n    ```\n\n\n## Usage\nWrite your plantuml code into a code block marked ``plantuml``:\n\n````markdown\n### Section X\n```plantuml\n@startuml\nAlice -\u003e Bob: Authentication Request\nBob --\u003e Alice: Authentication Response\n\nAlice -\u003e Bob: Another authentication Request\nAlice \u003c-- Bob: another authentication Response\n@enduml\n```\n````\n\n\n## Options\n## skin\nBy default, we set the skin of the plantuml to [a cleaner version](https://github.com/matthewjosephtaylor/plantuml-style) for you.\nHowever, You can still switch with this option (`skin`) if you prefer the classic one.\n\nAll available values are:\n- `default`\n- `classic`\n\nFor example:\n```\n\u003cscript\u003e\nwindow.$docsify = {\n  plantuml: {\n    skin: 'classic',\n  },\n}\n\u003c/script\u003e\n```\n\n## serverPath\nBy default, the official PlantUML server is used. If you have your own, configure it using the `serverPath` option:\n\n```\n\u003cscript\u003e\nwindow.$docsify = {\n  plantuml: {\n    serverPath: 'https://custom-server.local/plantuml/png/',\n  },\n}\n\u003c/script\u003e\n```\n\n## renderSvgAsObject\nBy default, the svg is renderd inside an `\u003cimg src=''/\u003e` tag. \nIf you want interactive svg (like links) configure the `renderSvgAsObject` option:\nThis will render like: `\u003cobject type='image/svg+xml' data=''/\u003e`\n\n```\n\u003cscript\u003e\nwindow.$docsify = {\n  plantuml: {\n    renderSvgAsObject: true,\n  },\n}\n\u003c/script\u003e\n```\nPlease note that relative urls should start with `$`\n````markdown\n```plantuml\n@startuml\nAlice -\u003e Bob: Authentication Request [[$./other-file docs]]\nBob --\u003e Alice: Authentication Response [[$../other-file docs]]\n@enduml\n```\n````\n\n## Example\n### Basic Usage\n- [index.html](example/basic/index.html)\n- [README.md](https://raw.githubusercontent.com/imyelo/docsify-plantuml/master/example/basic/README.md)\n\n### Render as SVG Object\n- [index.html](example/svg-object/index.html)\n\n\n## Related\n- [docsify](https://github.com/QingWei-Li/docsify/)\n- [PlantUML](http://plantuml.com/)\n\n\n## License\nMIT \u0026copy; yelo, 2017 - present\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimyelo%2Fdocsify-plantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimyelo%2Fdocsify-plantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimyelo%2Fdocsify-plantuml/lists"}