theme-next / theme-next-reading-progress

Reading Progress for NexT.

Reading Progress 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:

$ cd themes/next
$ ls
bower.json  _config.yml  docs  gulpfile.coffee  languages  layout  LICENSE.md  package.json  README.md  scripts  source  test

Step 2 → Get module

Install module to source/lib directory:

$ git clone https://github.com/theme-next/theme-next-reading-progress source/lib/reading_progress

Step 3 → Set it up

Enable module in NexT _config.yml file:

reading_progress:
  enable: true
  color: "#37c6c0"
  height: 2px

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

vendors:
  ...
  reading_progress: //cdn.jsdelivr.net/gh/theme-next/theme-next-reading-progress@1/reading_progress.min.js

Update

$ cd themes/next/source/lib/reading_progress
$ git pull