gitbook-plugin-flow

    1.1.7 • Public • Published

    gitbook-plugin-flow

    NPM

    flowchart.js plugin for GitBook

    Installation

    $ npm install gitbook-plugin-flow
    

    book.json add the plugin

    {
      "plugins": ["flow"]
    }
    

    Features

    • Support HTML, PDF, EPUB output(make sure your gitbook support SVG)
    • Support ```flow code block quote
    • Multi code style support

    Configuration

    book.json add the flowchart.js options

    "pluginsConfig": {
      "flow": {
        "line-color": "red"
      }
    }
    

    Usage

    To include a sequence diagram, just wrap your definition in a "flow" 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
    
    ```
    

    Also you can put in your book block as

    {% flow %}
    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
    {% endflow %}
    

    In addition you can use these code

    {% 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

    {% flow width=770 %}
    

    Reference and Thanks

    This project learn from:

    Install

    npm i gitbook-plugin-flow

    DownloadsWeekly Downloads

    1

    Version

    1.1.7

    License

    MIT

    Last publish

    Collaborators

    • vowstar