https://github.com/theme-next/theme-next-canvas-ribbon

canvas-ribbon.js for NexT.
https://github.com/theme-next/theme-next-canvas-ribbon

canvas-ribbon module theme-next

Last synced: 3 months ago
JSON representation

canvas-ribbon.js for NexT.

• Host: GitHub
• URL: https://github.com/theme-next/theme-next-canvas-ribbon
• Owner: theme-next
• License: mit
• Created: 2017-12-31T08:35:25.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-05T23:24:05.000Z (about 6 years ago)
• Last Synced: 2024-02-23T21:37:25.803Z (over 2 years ago)
• Topics: canvas-ribbon, module, theme-next
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 14
• Watchers: 13
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


canvas-ribbon.js for NexT



Installation


If you want to use the CDN instead of clone this repo, please jump to the Step 3.


Step 1 → Go to NexT dir


Change dir to **NexT** directory. There must be `layout`, `source`, `languages` and other directories:

```sh

$ cd themes/next

$ ls

_config.yml  crowdin.yml  docs  gulpfile.js  languages  layout  LICENSE.md  package.json  README.md  scripts  source

```

Step 2 → Get module


Install module to `source/lib` directory:

```sh

$ git clone https://github.com/theme-next/theme-next-canvas-ribbon source/lib/canvas-ribbon

```

Step 3 → Set it up


Enable module in **NexT** `_config.yml` file:

```yml

canvas_ribbon:

  enable: true

```

**And, if you wants to use the CDN, then need to set:**

```yml

vendors:

  ...

  canvas_ribbon: //cdn.jsdelivr.net/gh/theme-next/theme-next-canvas-ribbon@1/canvas-ribbon.js

```

Update


```sh

$ cd themes/next/source/lib/canvas-ribbon

$ git pull

```