hexo-filter-sequence-fix
v1.0.0
Published
Generate UML sequence diagrams for Hexo.
Downloads
1
Maintainers
Readme
hexo-filter-sequence
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!
```
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
- hexo-toc Insert a markdown TOC before posts be rendered.
- hexo-filter-fenced-code Extend syntax for the native fenced code block.
- hexo-filter-flowchart Generate flowchart diagrams for Hexo.
- hexo-filter-sub Generate subscript (
<sub>
) tag for Hexo. - hexo-filter-sup Generate superscript (
<sup>
) tag for Hexo. - hexo-theme-formula Hexo theme base on jade and less.
Contributing
Pull requests and stars are highly welcome.
For bugs and feature requests, please create an issue.