https://github.com/midnightsuyama/gitbook-plugin-flowchart

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

gitbook

Last synced: 17 days ago
JSON representation

flowchart.js plugin for GitBook

• Host: GitHub
• URL: https://github.com/midnightsuyama/gitbook-plugin-flowchart
• Owner: midnightSuyama
• Created: 2016-02-23T16:14:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-25T15:30:39.000Z (over 9 years ago)
• Last Synced: 2025-06-02T11:07:37.204Z (about 1 month ago)
• Topics: gitbook
• Language: JavaScript
• Size: 40 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gitbook-plugin-flowchart

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

[flowchart.js](https://github.com/adrai/flowchart.js) plugin for [GitBook](https://github.com/GitbookIO/gitbook)

## Installation

    $ npm install gitbook-plugin-flowchart

book.json add the plugin

```

{

  "plugins": ["flowchart"]

}

```

## Configuration

book.json add the flowchart.js options

```

"pluginsConfig": {

  "flowchart": {

    "line-color": "red"

  }

}

```

## Usage

put in your book block as

```

{% flowchart %}

st=>start: Start:>http://www.google.com[blank]

e=>end:>http://www.google.com

op1=>operation: My Operation

sub1=>subroutine: My Subroutine

cond=>condition: Yes

or No?:>http://www.google.com

io=>inputoutput: catch something...

st->op1->cond

cond(yes)->io->e

cond(no)->sub1(right)->op1

{% endflowchart %}

```

### Extend the width

```

{% flowchart width=770 %}

```