https://github.com/midnightsuyama/gitbook-plugin-sequence-diagrams

js-sequence-diagrams plugin for GitBook
https://github.com/midnightsuyama/gitbook-plugin-sequence-diagrams

gitbook

Last synced: about 2 months ago
JSON representation

js-sequence-diagrams plugin for GitBook

• Host: GitHub
• URL: https://github.com/midnightsuyama/gitbook-plugin-sequence-diagrams
• Owner: midnightSuyama
• Created: 2016-02-24T15:04:09.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-25T15:34:23.000Z (almost 9 years ago)
• Last Synced: 2024-11-10T22:46:37.503Z (2 months ago)
• Topics: gitbook
• Language: JavaScript
• Size: 69.3 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gitbook-plugin-sequence-diagrams

[![NPM](https://nodei.co/npm/gitbook-plugin-sequence-diagrams.png)](https://nodei.co/npm/gitbook-plugin-sequence-diagrams/)

[js-sequence-diagrams](https://github.com/bramp/js-sequence-diagrams) plugin for [GitBook](https://github.com/GitbookIO/gitbook)

## Installation

    $ npm install gitbook-plugin-sequence-diagrams

book.json add the plugin

```

{

  "plugins": ["sequence-diagrams"]

}

```

## Configuration

book.json add the js-sequence-diagrams options

```

"pluginsConfig": {

  "sequence-diagrams": {

    "theme": "simple"

  }

}

```

## Usage

put in your book block as

```

{% sequence %}

Alice->Bob: Hello Bob, how are you?

Note right of Bob: Bob thinks

Bob-->Alice: I am good thanks!

{% endsequence %}

```

### Extend the width

```

{% sequence width=770 %}

```