{"analyzedAt":"2022-07-09T19:48:51.102Z","collected":{"metadata":{"name":"gitbook-plugin-graphviz-and-plant-uml","scope":"unscoped","version":"1.0.6","description":"Generate PlantUML with quick installation","date":"2019-04-03T13:37:56.246Z","publisher":{"username":"miao1007","email":"miao1007@gmail.com"},"maintainers":[{"username":"miao1007","email":"miao1007@gmail.com"}],"repository":{"type":"git","url":"git+https://github.com/miao1007/gitbook-plugin-GraphvizAndPlantUML.git"},"links":{"npm":"https://www.npmjs.com/package/gitbook-plugin-graphviz-and-plant-uml","homepage":"https://github.com/miao1007/gitbook-plugin-GraphvizAndPlantUML","repository":"https://github.com/miao1007/gitbook-plugin-GraphvizAndPlantUML","bugs":"https://github.com/miao1007/gitbook-plugin-GraphvizAndPlantUML/issues"},"license":"Apache-2.0","devDependencies":{"gitbook-tester":"1.4.2"},"releases":[{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2020-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1}],"hasTestScript":true,"readme":"Render GraphViz and PlantUML offline.\n\n[![version](https://img.shields.io/npm/v/gitbook-plugin-graphviz-and-plant-uml.svg)](https://www.npmjs.com/package/gitbook-plugin-graphviz-and-plant-uml)\n[![download](https://img.shields.io/npm/dm/gitbook-plugin-graphviz-and-plant-uml.svg)](https://www.npmjs.com/package/gitbook-plugin-graphviz-and-plant-uml)\n\n\n## Features\n* Rendering PlantUML from local or server.\n* Support PDF exporting.\n* ZERO npm dependency.\n\n## How Does it work\n\n1. Your UML/Diagram string quote with PlantUML/DOT\n2. run exec file and get output\n3. SVG(XML) file\n4. <img src='data:image/svg+xml;base64,xxxx'>\n\n\n## Pre Installation\n\n### Server Side\n\nNothing but same as <https://github.com/qjebbs/vscode-plantuml#requirements-for-plantumlserver-render>\n\n\n### Client Side\n\n* [Java](https://java.com) is a cross-platform Virtual Machine, which is install on Mac/Linux by default.\n* [Graphviz](https://www.graphviz.org) is open source graph visualization software. It has several main graph layout programs.\n* [plantuml](http://plantuml.com/) can easily create UML Diagrams from simple textual description.\n\nWe need to install these tools before rendering UML.\n\nIf your are Mac user, try with [brew](https://brew.sh/)\n\n```sh\nbrew install graphviz\nbrew install plantuml\n```\n\nIf your are the other OS user, install them manually on official website or package manager(eg, yum install graphviz).\n\n\n## Installation for Gitbook\n\nIn your book.json\n\n\n## Server Side Rendering\n\nPlease keep in mind, if you want more about privacy/safety, please replace your own LOCAL render server.\n\n```json\n{\n  \"plugins\": [\"graphviz-and-plant-uml\"],\n  \"pluginsConfig\": {\n    \"graphviz-and-plant-uml\": {\n      \"Render\": \"PlantUMLServer\",\n      \"Server\": \"http://www.plantuml.com/plantuml\"\n    }\n  }\n}\n```\n\n## Client Side Rendering\n\n```json\n{\n  \"plugins\": [\"graphviz-and-plant-uml\"],\n  \"pluginsConfig\": {\n    \"graphviz-and-plant-uml\": {\n      \"GraphvizDotFile\": \"/usr/local/opt/graphviz/bin/dot\",\n      \"PlantJar\": \"/usr/local/Cellar/plantuml/1.2018.12/libexec/plantuml.jar\"\n    }\n  }\n}\n```\n\nAnd all, finally\n\nthen\n\n```sh\n# install plugin\ngitbook install\n# run the gitbook\ngitbook serve\n```\n\n### How to use it?\n\n\n```\n{% puml %}\n@startuml\nObject <|-- ArrayList\nObject : equals()\nArrayList : Object[] elementData\nArrayList : size()\n@enduml\n{% endpuml %}\n```\n\n> `@startuml` and `@endpuml` are ALWAYS required or the image will fail to be generated.\n\nor\n\n    ```puml\n    @startuml\n    Object <|-- ArrayList\n    Object : equals()\n    ArrayList : Object[] elementData\n    ArrayList : size()\n    @enduml\n    ```\n\nPlugin will pick up block body and replace it with generated base64 svg diagram.\n\n> `puml` and `plantuml` tags both work.\n\n> see more at Jetbrains's [Visualizing Diagrams](https://www.jetbrains.com/help/idea/markdown.html)"},"npm":{"downloads":[{"from":"2022-07-08T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-07-02T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":1},{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":14},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":83},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":153},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":281}],"starsCount":0},"github":{"starsCount":2,"forksCount":0,"subscribersCount":3,"issues":{"count":1,"openCount":0,"distribution":{"3600":0,"10800":1,"32400":0,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"miao1007","commitsCount":15},{"username":"fabianhauser","commitsCount":1}],"commits":[{"from":"2022-07-02T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-06-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-04-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2022-01-10T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0},{"from":"2021-07-09T00:00:00.000Z","to":"2022-07-09T00:00:00.000Z","count":0}]},"source":{"files":{"readmeSize":2813,"testsSize":6614},"badges":[{"urls":{"original":"https://img.shields.io/npm/v/gitbook-plugin-graphviz-and-plant-uml.svg","shields":"https://img.shields.io/npm/v/gitbook-plugin-graphviz-and-plant-uml.svg","content":"https://img.shields.io/npm/v/gitbook-plugin-graphviz-and-plant-uml.json"},"info":{"service":"npm","type":"version","modifiers":{"type":"v"}}},{"urls":{"original":"https://img.shields.io/npm/dm/gitbook-plugin-graphviz-and-plant-uml.svg","shields":"https://img.shields.io/npm/dm/gitbook-plugin-graphviz-and-plant-uml.svg","content":"https://img.shields.io/npm/dm/gitbook-plugin-graphviz-and-plant-uml.json"},"info":{"service":"npm","type":"downloads","modifiers":{"type":"dm"}}}]}},"evaluation":{"quality":{"carefulness":0.71,"tests":0.6,"health":1,"branding":0.3},"popularity":{"communityInterest":7,"downloadsCount":27.666666666666668,"downloadsAcceleration":-0.05576484018264838,"dependentsCount":0},"maintenance":{"releasesFrequency":0.9,"commitsFrequency":0.9,"openIssues":1,"issuesDistribution":1}},"score":{"final":0.6337834692013204,"detail":{"quality":0.9037267146368496,"popularity":0.03624257630286548,"maintenance":0.9999444374407507}}}