Generate UML sequence diagrams for Hexo.
JavaScript
Latest commit 59c9734 Jan 13, 2017 @bubkoo v1.0.1
Permalink
Failed to load latest commit information.
lib README Jan 10, 2017
.editorconfig init Jan 9, 2017
.gitignore init Jan 9, 2017
.npmignore init Jan 9, 2017
LICENSE Initial commit Jan 9, 2017
README.md snapshot.svg Jan 13, 2017
index.js README Jan 10, 2017
package.json v1.0.1 Jan 13, 2017
snapshot.svg snapshot.svg Jan 13, 2017

README.md

hexo-filter-sequence

MIT License

npm: Package Quality

Generate UML sequence diagrams for Hexo.

Install

npm install --save hexo-filter-sequence

Usage

This plugin is based on js-sequence-diagrams, so you can defined the chart as follow:

```sequence
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
```

snapshot.svg

Config

In your site's _config.yml:

sequence:
  webfont:
  snap:        
  underscore:
  sequence:
  css: # the url for css, such as hand drawn theme 
  options: 
    theme: 
    css_class: 

Your config will be merged into default config:

{
  "webfont": "https://cdnjs.cloudflare.com/ajax/libs/webfont/1.6.27/webfontloader.js",
  "snap": "https://cdnjs.cloudflare.com/ajax/libs/snap.svg/0.4.1/snap.svg-min.js",
  "underscore": "https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.3/underscore-min.js",
  "sequence": "https://cdnjs.cloudflare.com/ajax/libs/js-sequence-diagrams/1.0.6/sequence-diagram-min.js",
  "style": "",
  "options": {
    "theme": "simple",
    "css_class": ""
  }
}

Related

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.