https://github.com/bubkoo/hexo-filter-sequence

Generate UML sequence diagrams for Hexo.
https://github.com/bubkoo/hexo-filter-sequence

hexo-filter hexo-filter-sequence uml-sequence-diagram

Last synced: 2 months ago
JSON representation

Generate UML sequence diagrams for Hexo.

• Host: GitHub
• URL: https://github.com/bubkoo/hexo-filter-sequence
• Owner: bubkoo
• License: mit
• Created: 2017-01-09T17:54:41.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-03-05T07:42:02.000Z (over 7 years ago)
• Last Synced: 2025-04-30T16:19:40.841Z (2 months ago)
• Topics: hexo-filter, hexo-filter-sequence, uml-sequence-diagram
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 40
• Watchers: 4
• Forks: 11
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hexo-filter-sequence

[![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/bubkoo/hexo-filter-sequence/blob/master/LICENSE)

[![npm:](https://img.shields.io/npm/v/hexo-filter-sequence.svg?style=flat-square)](https://www.npmjs.com/packages/hexo-filter-sequence)

[![Package Quality](http://npm.packagequality.com/shield/hexo-filter-sequence.svg)](http://packagequality.com/#?package=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](https://github.com/bramp/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](https://cdn.rawgit.com/bubkoo/hexo-filter-sequence/master/snapshot.svg)

## Config

   

In your site's `_config.yml`:

```yaml

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:

```json

{

  "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](https://github.com/bubkoo/hexo-toc) Insert a markdown TOC before posts be rendered.

- [hexo-filter-fenced-code](https://github.com/bubkoo/hexo-filter-fenced-code) Extend syntax for the native fenced code block.

- [hexo-filter-flowchart](https://github.com/bubkoo/hexo-filter-flowchart) Generate flowchart diagrams for Hexo.

- [hexo-filter-sub](https://github.com/bubkoo/hexo-filter-sub) Generate subscript (``) tag for Hexo.

- [hexo-filter-sup](https://github.com/bubkoo/hexo-filter-sup) Generate superscript (``) tag for Hexo.

- [hexo-theme-formula](https://github.com/bubkoo/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](https://github.com/bubkoo/hexo-filter-sequence/issues/new).