hexo-filter-sequence-fix

1.0.0 • Public • Published

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:     # optional, the source url of webfontloader.js 
  # snap:        # optional, the source url of snap.svg.js 
  # underscore:  # optional, the source url of underscore.js 
  # sequence:    # optional, the source url of sequence-diagram.js 
  # css: # optional, 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.

Package Sidebar

Install

npm i hexo-filter-sequence-fix

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

11.3 kB

Total Files

6

Last publish

Collaborators

  • axis