supplescroll

converts markdown to HTML with integrated table of contents and figure panel, tied together with some supple scrolling


License
BSD-3-Clause
Install
pip install supplescroll==2.1.1

Documentation

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.