{"id":21228387,"url":"https://github.com/zuisong/docsify-kroki","last_synced_at":"2026-03-07T11:04:01.390Z","repository":{"id":43871627,"uuid":"346648148","full_name":"zuisong/docsify-kroki","owner":"zuisong","description":"A docsify plugin to render graph like plantuml, mermaid, ..etc","archived":false,"fork":false,"pushed_at":"2025-11-21T02:06:48.000Z","size":2363,"stargazers_count":18,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-21T03:34:35.871Z","etag":null,"topics":["docsify","docsify-plugin","kroki","markdown","text-visualization","visualization"],"latest_commit_sha":null,"homepage":"https://zuisong.github.io/docsify-kroki/","language":"TypeScript","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/zuisong.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-03-11T09:31:57.000Z","updated_at":"2025-11-21T01:56:21.000Z","dependencies_parsed_at":"2024-02-09T00:04:04.204Z","dependency_job_id":"ef4e3bad-298d-4ee7-aa32-4fec469d678e","html_url":"https://github.com/zuisong/docsify-kroki","commit_stats":{"total_commits":115,"total_committers":3,"mean_commits":"38.333333333333336","dds":"0.11304347826086958","last_synced_commit":"de34a24131e71bba295f1396acc0fcc427d107e9"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/zuisong/docsify-kroki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zuisong%2Fdocsify-kroki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zuisong%2Fdocsify-kroki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zuisong%2Fdocsify-kroki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zuisong%2Fdocsify-kroki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zuisong","download_url":"https://codeload.github.com/zuisong/docsify-kroki/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zuisong%2Fdocsify-kroki/sbom","scorecard":{"id":1237022,"data":{"date":"2025-08-25","repo":{"name":"github.com/zuisong/docsify-kroki","commit":"3729ccbcd454e93d72c5c483896cb86a482a8284"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":3.4,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/24 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/npm-publish.yml:11","Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/build.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/build.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/npm-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/npm-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/npm-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/zuisong/docsify-kroki/npm-publish.yml/main?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license:0","Info: FSF or OSI recognized license: MIT License: license:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}}]},"last_synced_at":"2025-09-05T03:19:26.102Z","repository_id":43871627,"created_at":"2025-09-05T03:19:26.102Z","updated_at":"2025-09-05T03:19:26.102Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30212103,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T09:02:10.694Z","status":"ssl_error","status_checked_at":"2026-03-07T09:02:08.429Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["docsify","docsify-plugin","kroki","markdown","text-visualization","visualization"],"created_at":"2024-11-20T23:18:25.115Z","updated_at":"2026-03-07T11:03:56.378Z","avatar_url":"https://github.com/zuisong.png","language":"TypeScript","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# docsify-kroki\n\n[![npm](https://img.shields.io/npm/v/docsify-kroki)](https://www.npmjs.com/package/docsify-kroki)\n[![codecov](https://codecov.io/gh/zuisong/docsify-kroki/branch/main/graph/badge.svg?token=WGS18HO5N6)](https://codecov.io/gh/zuisong/docsify-kroki)\n![GitHub branch checks state](https://img.shields.io/github/checks-status/zuisong/docsify-kroki/main)\n[![npm bundle size](https://img.shields.io/bundlephobia/min/docsify-kroki)](https://bundlephobia.com/package/docsify-kroki)\n[![npm bundle size(ziped)](https://img.shields.io/bundlephobia/minzip/docsify-kroki)](https://bundlephobia.com/package/docsify-kroki)\n![GitHub top language](https://img.shields.io/github/languages/top/zuisong/docsify-kroki)\n[![GitHub last commit](https://img.shields.io/github/last-commit/zuisong/docsify-kroki)](https://github.com/zuisong/docsify-kroki/commits/main)\n[![npm download count](https://img.shields.io/npm/dm/docsify-kroki)](https://npmtrends.com/docsify-kroki)\n\n## Install\n\n1. Insert script into docsify document:\n\n```html\n\u003cscript src=\"//unpkg.com/docsify-kroki\"\u003e\u003c/script\u003e\n```\n\n## Usage\n\n````markdown\n#Demo\n\n## embedding it directly\n\n```mermaid\ngraph TD;\n    A--\u003eB;\n    A--\u003eC;\n    B--\u003eD;\n    C--\u003eD;\n```\n\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## load from external files\n\n![kroki-excalidraw](./docs/excalidraw.json)\n````\n\n## Options\n\n```html\n\u003cscript\u003e\n  window.$docsify = {\n    // default\n    kroki: {\n      langs: [\n        \"actdiag\",\n        \"blockdiag\",\n        \"bpmn\",\n        \"bytefield\",\n        \"c4plantuml\",\n        \"d2\",\n        \"dbml\",\n        \"ditaa\",\n        \"erd\",\n        \"excalidraw\",\n        \"graphviz\",\n        \"mermaid\",\n        \"nomnoml\",\n        \"nwdiag\",\n        \"packetdiag\",\n        \"pikchr\",\n        \"plantuml\",\n        \"rackdiag\",\n        \"seqdiag\",\n        \"structurizr\",\n        \"svgbob\",\n        \"symbolator\",\n        \"tikz\",\n        \"vega\",\n        \"vegalite\",\n        \"wavedrom\",\n        \"wireviz\",\n      ],\n      // default\n      serverPath: \"//kroki.io/\",\n    },\n  };\n\u003c/script\u003e\n```\n\n### langs\n\nBy default, those markdown language render by kroki:\n\n|            |              |            |             |               |\n| ---------- | ------------ | ---------- | ----------- | ------------- |\n| `actdiag`  | `blockdiag`  | `bpmn`     | `bytefield` | `c4plantuml`  |\n| `d2`       | `dbml`       | `ditaa`    | `erd`       | `excalidraw`  |\n| `graphviz` | `mermaid`    | `nomnoml`  | `nwdiag`    | `packetdiag`  |\n| `pikchr`   | `plantuml`   | `rackdiag` | `seqdiag`   | `structurizr` |\n| `svgbob`   | `symbolator` | `tikz`     | `vega`      | `vegalite`    |\n| `wavedrom` | `wireviz`    |            |             |               |\n\nyou can add more to langs array.\n\n### serverPath\n\nBy default, the official Kroki server is used. If you have your own, configure\nit using the `serverPath` option:\n\n## Example\n\n- [index.html](docs/index.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzuisong%2Fdocsify-kroki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzuisong%2Fdocsify-kroki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzuisong%2Fdocsify-kroki/lists"}