{"id":16237591,"url":"https://github.com/vowstar/gitbook-plugin-sequence","last_synced_at":"2025-03-19T16:30:18.956Z","repository":{"id":64782084,"uuid":"70478104","full_name":"vowstar/gitbook-plugin-sequence","owner":"vowstar","description":"sequence plugin honkit/gitbook  to prase js-sequence-diagrams code and support PDF","archived":false,"fork":false,"pushed_at":"2025-03-10T07:39:22.000Z","size":1525,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T08:45:44.895Z","etag":null,"topics":["gitbook","honkit","honkit-plugin","sequence"],"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-10T10:38:09.000Z","updated_at":"2025-03-10T07:39:19.000Z","dependencies_parsed_at":"2023-02-10T07:31:09.749Z","dependency_job_id":"f1020630-ee09-4673-ac44-18adcd89f9fa","html_url":"https://github.com/vowstar/gitbook-plugin-sequence","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.0625,"last_synced_commit":"383ffa01f8932a68b3015d16551b4d8cd2ded089"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-sequence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-sequence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-sequence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-sequence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vowstar","download_url":"https://codeload.github.com/vowstar/gitbook-plugin-sequence/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244463537,"owners_count":20456905,"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":["gitbook","honkit","honkit-plugin","sequence"],"created_at":"2024-10-10T13:36:16.175Z","updated_at":"2025-03-19T16:30:18.605Z","avatar_url":"https://github.com/vowstar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gitbook-plugin-sequence\n\n[![Build Status](https://github.com/vowstar/gitbook-plugin-sequence/actions/workflows/test.yml/badge.svg)](https://github.com/vowstar/gitbook-plugin-sequence/actions)\n[![Coverage Status](https://coveralls.io/repos/github/vowstar/gitbook-plugin-sequence/badge.svg?branch=master)](https://coveralls.io/github/vowstar/gitbook-plugin-sequence?branch=master)\n[![NPM Version](https://img.shields.io/npm/v/gitbook-plugin-sequence.svg?style=flat)](https://www.npmjs.org/package/gitbook-plugin-sequence)\n[![NPM Downloads](https://img.shields.io/npm/dm/gitbook-plugin-sequence.svg?style=flat)](https://www.npmjs.org/package/gitbook-plugin-sequence)\n\n[js-sequence-diagrams](https://github.com/bramp/js-sequence-diagrams) 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-sequence\n```\n\nAdd this plugin into ``book.json``.\n\n```json\n{\n  \"plugins\": [\"sequence\"]\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\nThe default config is ``\"theme\": \"simple\"``.\n\nbook.json add the js-sequence-diagrams options\n\n```json\n\"pluginsConfig\": {\n  \"sequence\": {\n    \"theme\": \"simple\"\n  }\n}\n```\n\n## Usage\n\n\nTo include a sequence diagram, just wrap your definition in a \"sequence\" code block. For example:\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```sequence\n    Title: Here is a title\n    A-\u003eB: Normal line\n    B--\u003eC: Dashed line\n    C-\u003e\u003eD: Open arrow\n    D--\u003e\u003eA: Dashed open arrow\n```\n\u003c/code\u003e\u003c/pre\u003e\n\nAlso you can put in your book block as\n\n```bash\n{% sequence %}\nAlice-\u003eBob: Hello Bob, how are you?\nNote right of Bob: Bob thinks\nBob--\u003eAlice: I am good thanks!\n{% endsequence %}\n```\n\n### Extend the width\n\n```bash\n{% sequence width=770 %}\n```\n\n## Thanks\n\nThis project learn from:\n\n* [midnightSuyama/gitbook-plugin-flowchart](https://github.com/midnightSuyama/gitbook-plugin-flowchart).\n* [midnightSuyama/gitbook-plugin-sequence-diagrams](https://github.com/midnightSuyama/gitbook-plugin-sequence-diagrams).\n* [massanek/gitbook-plugin-js-sequence-diagram](https://github.com/gmassanek/gitbook-plugin-js-sequence-diagram).\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 charts and pie charts |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvowstar%2Fgitbook-plugin-sequence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvowstar%2Fgitbook-plugin-sequence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvowstar%2Fgitbook-plugin-sequence/lists"}