https://github.com/vxhly/vuepress-plugin-nest

A vuepress plugin for canvas-nest.js
https://github.com/vxhly/vuepress-plugin-nest

canvas-nest nest vuepress vuepress-nest

Last synced: 4 months ago
JSON representation

A vuepress plugin for canvas-nest.js

• Host: GitHub
• URL: https://github.com/vxhly/vuepress-plugin-nest
• Owner: vxhly
• License: other
• Created: 2019-09-12T04:47:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-08T08:14:00.000Z (almost 4 years ago)
• Last Synced: 2024-09-29T01:42:46.177Z (8 months ago)
• Topics: canvas-nest, nest, vuepress, vuepress-nest
• Language: Vue
• Homepage: https://vxhly.github.io/
• Size: 9.77 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vuepress-plugin-nest

> A vuepress plugin for canvas-nest.js

[![npm](https://img.shields.io/npm/v/vuepress-plugin-nest.svg)](https://www.npmjs.com/package/vuepress-plugin-nest)

[![GitHub stars](https://img.shields.io/github/stars/vxhly/vuepress-plugin-nest)](https://github.com/vxhly/vuepress-plugin-nest/stargazers)

[![GitHub license](https://img.shields.io/github/license/vxhly/vuepress-plugin-nest)](https://github.com/vxhly/vuepress-plugin-nest/blob/master/LICENSE)

## Install

``` bash

# install dependencies

npm i vuepress-plugin-nest -D

# or use yarn

yarn add vuepress-plugin-nest -D

```

## Usage

Write vuepress config

``` javascript

module.exports = {

  plugins: ['nest']

}

```

## Options

This plugin supports the following configurations.

``` javascript

module.exports = {

  plugins: ['nest', {

    color: '0,0,0', // color of lines, default: '0,0,0'; RGB values: (R,G,B).(note: use ',' to separate.)

    pointColor: '0,0,0', // color of points, default: '0,0,0'; RGB values: (R,G,B).(note: use ',' to separate.)

    opacity: 0.5, // the opacity of line (0~1), default: 0.5.

    count: 99, // the number of lines, default: 99.

    zIndex: -1 // z-index property of the background, default: -1.

    showInMobile: false // whether to display on the mobile side, default: false.

  }]

}

```

## Thanks

- [canvas-nest.js](https://github.com/hustcc/canvas-nest.js)

## License

[MIT](https://github.com/vxhly/vuepress-plugin-nest/blob/master/LICENSE).