CN-Sean / gitbook-plugin-new-flowchart

New Flowchart Plugin

Install the New Flowchart plugin via NPM, which should be installed globally using the -g option:

$ npm install gitbook-plugin-new-flowchart -g

As you are installing globally, you may need to put sudo in front of the command, sudo npm install gitbook-plugin-new-flowchart -g

To use the plugin in your Gitbook project, add the plugin to the book.json file.

{
    "plugins": ["new-flowchart"]
}

Then, to include a sequence diagram, just wrap your definition in a "sequence" code block. For example:

``` flow
st=>start: Start|past:>http://www.google.com[blank]
e=>end: End:>http://www.google.com
op1=>operation: My Operation|past
op2=>operation: Stuff|current
sub1=>subroutine: My Subroutine|invalid
cond=>condition: Yes
or No?|approved:>http://www.google.com
c2=>condition: Good idea|rejected
io=>inputoutput: catch something...|request

st->op1(right)->cond
cond(yes, right)->c2
cond(no)->sub1(left)->op1
c2(yes)->io->e
c2(no)->op2->e
```

Please reference the flowchart.js documentation for details on syntax.

Reference

This project inspiration from gmassanek/gitbook-plugin-js-sequence-diagram.