{"id":16237574,"url":"https://github.com/vowstar/gitbook-plugin-flow","last_synced_at":"2025-03-19T16:30:18.516Z","repository":{"id":64715482,"uuid":"70466907","full_name":"vowstar/gitbook-plugin-flow","owner":"vowstar","description":"flowchat honkit/gitbook plugin to prase flowchart.js code","archived":false,"fork":false,"pushed_at":"2024-11-07T09:04:56.000Z","size":456,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T14:04:25.774Z","etag":null,"topics":["flowchat","gitbook","honkit","honkit-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vowstar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2016-10-10T08:20:10.000Z","updated_at":"2024-10-30T05:59:52.000Z","dependencies_parsed_at":"2023-01-31T11:15:45.100Z","dependency_job_id":"baac8bb6-2987-455a-8f88-23c8e41a593f","html_url":"https://github.com/vowstar/gitbook-plugin-flow","commit_stats":{"total_commits":24,"total_committers":2,"mean_commits":12.0,"dds":0.04166666666666663,"last_synced_commit":"a681ac3584a1fd544ecabae3fa0f6e1abc703982"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vowstar","download_url":"https://codeload.github.com/vowstar/gitbook-plugin-flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243738980,"owners_count":20340001,"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":["flowchat","gitbook","honkit","honkit-plugin"],"created_at":"2024-10-10T13:36:11.037Z","updated_at":"2025-03-19T16:30:18.147Z","avatar_url":"https://github.com/vowstar.png","language":"JavaScript","readme":"# gitbook-plugin-flow\n\n[![Build Status](https://github.com/vowstar/gitbook-plugin-flow/actions/workflows/test.yml/badge.svg)](https://github.com/vowstar/gitbook-plugin-flow/actions)\n[![Coverage Status](https://coveralls.io/repos/github/vowstar/gitbook-plugin-flow/badge.svg?branch=master)](https://coveralls.io/github/vowstar/gitbook-plugin-flow?branch=master)\n[![NPM Version](https://img.shields.io/npm/v/gitbook-plugin-flow.svg?style=flat)](https://www.npmjs.org/package/gitbook-plugin-flow)\n[![NPM Downloads](https://img.shields.io/npm/dm/gitbook-plugin-flow.svg?style=flat)](https://www.npmjs.org/package/gitbook-plugin-flow)\n\n[flowchart.js](https://github.com/adrai/flowchart.js) plugin for [Honkit](https://github.com/honkit/honkit) ~~and [GitBook](https://github.com/GitbookIO/gitbook)~~.\n\n## Installation\n\n```bash\nnpm install gitbook-plugin-flow\n```\n\nAdd this plugin into ``book.json``.\n\n```json\n{\n  \"plugins\": [\"flow\"]\n}\n```\n\n## Features\n\n* Support HTML, PDF, EPUB output(make sure your gitbook support SVG)\n* Support ```flow code block quote\n* Multi code style support\n\n## Configuration\n\nbook.json add the flowchart.js options\n\n```json\n\"pluginsConfig\": {\n  \"flow\": {\n    \"line-color\": \"red\"\n  }\n}\n```\n\n## Usage\n\nTo include a sequence diagram, just wrap your definition in a \"flow\" code block. For example:\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```flow\nst=\u003estart: Start:\u003ehttp://www.google.com[blank]\ne=\u003eend:\u003ehttp://www.google.com\nop1=\u003eoperation: My Operation\nsub1=\u003esubroutine: My Subroutine\ncond=\u003econdition: Yes\nor No?:\u003ehttp://www.google.com\nio=\u003einputoutput: catch something...\n\nst-\u003eop1-\u003econd\ncond(yes)-\u003eio-\u003ee\ncond(no)-\u003esub1(right)-\u003eop1\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n\nAlso you can put in your book block as\n\n```bash\n{% flow %}\nst=\u003estart: Start:\u003ehttp://www.google.com[blank]\ne=\u003eend:\u003ehttp://www.google.com\nop1=\u003eoperation: My Operation\nsub1=\u003esubroutine: My Subroutine\ncond=\u003econdition: Yes\nor No?:\u003ehttp://www.google.com\nio=\u003einputoutput: catch something...\n\nst-\u003eop1-\u003econd\ncond(yes)-\u003eio-\u003ee\ncond(no)-\u003esub1(right)-\u003eop1\n{% endflow %}\n```\n\nIn addition you can use these code\n\n```bash\n{% flowchart %}\nst=\u003estart: Start:\u003ehttp://www.google.com[blank]\ne=\u003eend:\u003ehttp://www.google.com\nop1=\u003eoperation: My Operation\nsub1=\u003esubroutine: My Subroutine\ncond=\u003econdition: Yes\nor No?:\u003ehttp://www.google.com\nio=\u003einputoutput: catch something...\n\nst-\u003eop1-\u003econd\ncond(yes)-\u003eio-\u003ee\ncond(no)-\u003esub1(right)-\u003eop1\n{% endflowchart %}\n```\n\n### Extend the width\n\n```bash\n{% flow width=770 %}\nst=\u003estart: Start:\u003ehttp://www.google.com[blank]\ne=\u003eend:\u003ehttp://www.google.com\nop1=\u003eoperation: My Operation\nsub1=\u003esubroutine: My Subroutine\ncond=\u003econdition: Yes\nor No?:\u003ehttp://www.google.com\nio=\u003einputoutput: catch something...\n\nst-\u003eop1-\u003econd\ncond(yes)-\u003eio-\u003ee\ncond(no)-\u003esub1(right)-\u003eop1\n{% endflow %}\n```\n\n## Thanks\n\nThis project learn from:\n\n* [midnightSuyama/gitbook-plugin-flowchart](https://github.com/midnightSuyama/gitbook-plugin-flowchart).\n* [nsdont/gitbook-plugin-new-flowchart](https://github.com/nsdont/gitbook-plugin-new-flowchart).\n* [lyhcode/gitbook-plugin-plantuml](https://github.com/lyhcode/gitbook-plugin-plantuml).\n\n## See also\n\nThese plugins are also available on honkit.\n\n|                                    Plugin                                     |                      Description                       |\n| ----------------------------------------------------------------------------- | ------------------------------------------------------ |\n| [gitbook-plugin-uml](https://github.com/vowstar/gitbook-plugin-uml)           | A plug-in that use plantuml to draw beautiful pictures |\n| [gitbook-plugin-wavedrom](https://github.com/vowstar/gitbook-plugin-wavedrom) | A plug-in that can draw waveforms and register tables  |\n| [gitbook-plugin-sequence](https://github.com/vowstar/gitbook-plugin-sequence) | A plug-in that can draw sequence diagrams              |\n| [gitbook-plugin-flow](https://github.com/vowstar/gitbook-plugin-flow)         | A plug-in that can draw flowchart.js diagrams          |\n| [gitbook-plugin-echarts](https://github.com/vowstar/gitbook-plugin-echarts)   | A plug-in that can draw various charts such as bar/pie |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvowstar%2Fgitbook-plugin-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvowstar%2Fgitbook-plugin-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvowstar%2Fgitbook-plugin-flow/lists"}