True-paper-css NPM

True Paper CSS

A maintained fork of Paper CSS.

Why? I need it for a personal project, so I'm maintaining it now! That's how mafia (FOSS) works!

Contributing

Don't try to open issues, they are disabled for a good reason, instead ask questions on webforums and submit a MR with a fix or with documentation. My time is limited and I would rather merge MRs.
Please don't use MRs as issues, submit real contributions, like bugfixed, tooling updates, or new paper sizes.
Only metric units are allowed, ever!
You absolutely can not live without getting an answer or work out of me explicity? Follow this link to learn what you need to do.

Development

Docker image:

make build

Compile:

make sass

Run:

make shell

Publish

npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
npm whoami
npm publish

Preview:

make open

Contributing

Open a PR with anything from: https://papersizes.io/

License

Code referenced by commit c69fbe2d687c328345774fb81b5e81d40ea7ad47 is licensed MIT © Tsutomu Kawamura, see LICENSE.MIT.

The rest of the code is covered by the BSD 3-clause License, see LICENSE for more details.

OLD Description

Below you will find the old description (will be changed soon):

Front-end printing solution - previewable and live-reloadable!

Recently, we say "front-end" every day. Then why don't we make the printing documents in front-end? We believe we can make it perfectly without back-end. Paper CSS is just a small snippet of CSS, but it helps us create them in browser easily.

Installation
Basic Usage
Live Preview
PDF Generation
Why Paper CSS?
License

Installation

Get Paper CSS from cdnjs (recommended):

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/paper-css/0.3.0/paper.css">

Or download paper.css file from GitHub manually, or via npm:

$ npm install paper-css

Basic Usage

Load paper-css into <head> like this:

<!-- Load paper.css for happy printing -->
<link rel="stylesheet" href="dist/paper.css">

<!-- Set page size here: A5, A4 or A3 -->
<!-- Set also "landscape" if you need -->
<style>@page { size: A5 }</style>

Set the class of <body> and also set "sheet" for each sheet.

<!-- Set "A5", "A4" or "A3" for class name -->
<!-- Set also "landscape" if you need -->
<body class="A5">

  <!-- Each sheet element should have the class "sheet" -->
  <!-- "padding-**mm" is optional: you can set 10, 15, 20 or 25 -->
  <section class="sheet padding-10mm">

    <!-- Write HTML just like a web page -->
    <article>This is an A5 document.</article>

  </section>

</body>

All available page sizes is listed below:

A5, A5 landscape
A4, A4 landscape
A3, A3 landscape
letter, letter landscape
legal, legal landscape

Live Preview

Install live-server:

$ npm install --global live-server

Then, preview your HTML file:

$ live-server your-document.html

Your browser will open the document. And the browser will automatically reload the page when changes are detected.

See more detail and all options here.

PDF Generation

Install electron-pdf:

$ npm install --global electron-pdf

Then, generate a PDF file from your HTML file:

$ electron-pdf your-document.html your-document.pdf

See more details and all options here.

Note: we used to provide a small CLI tool paper-css while v0.2.x, we've dropped it in favor of electron-pdf which is a better option to do the same, basically.