interactive documents in javascript
CSS JavaScript Python Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
supplescroll
.gitignore
package.json
readme.md
supplebuild.js

readme.md

SUPPLESCROLL

Supplescroll is a javascript plugin that converts a plain HTML document into an interactive document with:

  • auto-generated table of contents
  • independent figure list
  • handy URL hashes
  • back links to references
  • context-aware auto-scrolling
  • movable dividers
  • iOS-aware/responsive themes

Full docs http://boscoh.github.io/supplescroll

Quick Install

> npm install -g supplescroll

Quick Usage

If you have a markdown file:

> supplescroll article.md light

If you have a standard html file:

> supplescroll article.html light

Then open article.html in the browser.

Available themes: light, dark, yeolde, clown and sphinx.