# gitbook-plugin-flowchart

> flowchart.js plugin for GitBook

Latest version **1.1.0** (published 2016-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install gitbook-plugin-flowchart
pnpm add gitbook-plugin-flowchart
yarn add gitbook-plugin-flowchart
bun add gitbook-plugin-flowchart
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-02-25 |
| First published | 2016-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | midnightSuyama |
| Maintainers | midnightsuyama |
| Keywords | flowchart, plugin, gitbook |

## Links

- npm: https://www.npmjs.com/package/gitbook-plugin-flowchart
- Repository: https://github.com/midnightSuyama/gitbook-plugin-flowchart
- Issues: https://github.com/midnightSuyama/gitbook-plugin-flowchart/issues
- npm.io page: https://npm.io/package/gitbook-plugin-flowchart

## Dependencies (2)

- [q](https://npm.io/package/q.md) ^1.4.1
- [phantom](https://npm.io/package/phantom.md) ^2.0.0

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2016-02-25
- 1.0.1 — 2016-02-24
- 1.0.0 — 2016-02-23

## 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 %}
```

---
_Source: https://npm.io/package/gitbook-plugin-flowchart · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._