Book layout in the browser
Clone or download
Permalink
Failed to load latest commit information.
docs
src
.eslintrc.js
.gitignore remove built version of bindery from docs Jun 21, 2018
.travis.yml
LICENSE
README.md
package-lock.json
package.json
rollup.config.js move regionize into its own module and repo Jun 1, 2018

README.md

Bindery.js

npm Build Status codecov npm bundle size (minified + gzip)

Intro · Guide · Docs · Demos · About

Bindery.js is a library for designing printable books with HTML and CSS.

At its simplest, Bindery flows content over multiple pages. From there, the designer can create elements that depend on that flow, like running headers, footnotes, tables of contents, and indexes. Bindery also provides print options like bleed, crop marks, and booklet ordering.

If you're designing a website, think about books as an extension of the responsive web. If you're designing a book, express your layouts programmatically, with no need for InDesign.

Getting Started

<div id="content">
  <!-- The contents of your book -->
</div>

<script src="https://unpkg.com/bindery"></script>
<script>
  Bindery.makeBook({ content: '#content' });
</script>

You can also install bindery from npm, or download directly.

npm install --save bindery

Using Rules

const { makeBook, PageBreak, Footnote } = Bindery;

makeBook({
  content: '#content',
  rules: [
    PageBreak({ selector: 'h2', position: 'before', continue: 'right' }),
    Footnote({
      selector: 'p > a',
      render: (el, num) => `${num}: Link to ${el.getAttribute('href')}`;
    }),
  ],
});

For more, see the Guide and Docs.

Developing

When contributing, keep in mind that bindery.js is intended to provide an approachable jumping-off point for HTML-to-Print exploration. Because of this, it is intended to work out of the box as a script tag (without needing to run a dev server, set up a development environment, use preprocessors, or know javascript at all).

  • npm run build - Updates dist/
  • npm run test - Runs Jest

To Do

  • Support for signatures and advanced ordering
  • Support for RTL languages
  • Examples for use with blogging platforms
  • Examples for use with React
  • Approachable API for writing custom rules

Background

bindery.js was originally written in Spring 2014 for for/with/in, a publication from participants in "HTML Output" at RISD. For more, see here.