Skip to content
A pagination library to convert markdown-compatible HTML into a Superbook.
JavaScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
art
bin
last
lib
templates
.editorconfig
.gitignore
LICENSE.md
README.md
package-lock.json
package.json

README.md

Hydrogen Sulfide

Treat your really long HTML scroll with some sulfur!

Surgical pagination of content into responsive pages of equal size that remain above the fold.


Installation

H2S is a CLI.

$ npm i -g h2s

$ h2s --help 		# Vocabulary


Usage

$ h2s [options] [command]

Options:
  -V, --version      output the version number
  -v, --version      output the version number
  -h, --help         output usage information

Commands

  1. $ h2s objectify|o        # Turn `sanitized.html` into an 'array like' JSON.
  2. $ h2s pagify|p           # Paginate with gadda-gadda line-tracking!
  3. $ h2s bookify|b          # Templatize markup with layout to form actual pages

Steps and their meaning:

  1. Place your sanitized.html at ./interim folder (sibling to the manuscript folder at the root of your Bookiza project).

  2. Execute $ h2s objectify to pull up the contents into a set of key: value pairs.

  3. Run $ h2s pagify to paginate the key: value pairs according to a responsive template at ./templates folder.

  4. Run $ h2s bookify to apply layout on paginated content and produce book. And voila, your Superbook is ready!

Run $ bookiza server to load your book on development server at localhost:4567.

You can’t perform that action at this time.