Nutex NPM | npm.io

Nutex

A modern solution for creating beautiful print and digital media.

About

Nutex is a "batteries-included" environment for creating PDF-based media, built on top of PrinceXML. Nutex aims to provide a more enjoyable workflow for media creation by providing useful features out of the box, and reducing the amount of configuration required to create great media.

Features

Out of the box, Nutex provides the following features:

a simpler syntax (Pug)
useful mixins for basic functionality
an easily-configurable default stylesheet
templates for documents/media
file watching (recompilation on save)
an environment that can be extended by the user.

Through the use of mixins, Nutex is able to offer:

automatically numbered headings
numbered/captioned figures
column layouts
footnotes

A default stylesheet is provided that can be configured through CSS variables. Things like page margins, line height, etc. are all customizable through variables so the total amount of CSS you have to write is reduced.

Prerequisites

Nutex utilizes PrinceXML for PDF generation - it must be installed on your system and in your PATH. While PrinceXML is proprietary software, a free version is available for non-commercial use. Ideally, support for WeasyPrint - a free and open-source alternative - will be added in the future, but is not planned at this time.

Installation

Nutex is most easily installed with NPM, as shown below.

$ npm install -g nutex

Alternatively, you can clone the repository, then build and install Nutex locally:

$ npm pack
$ npm install -g nutex.tgz

At this time, Nutex also requires a working PrinceXML installation, as it is responsible for producing PDFs from HTML. Support for WeasyPrint, a free and open-source alternative, is planned for the future.

Remember that Nutex is still under rapid and heavy construction. At this time:

the program is still evolving constantly;
only macOS and Linux are supported; and
future updates might break your configuration.

While it is capable of a good bit right now, use it with caution.

Usage

Compiling a document is simple:

$ nutex compile demo.pug

For a complete list of options, run nutex help.

Documentation

There is no official documentation available at this time. Look at the examples in the examples folder for guidance, as well as the PrinceXML Documentation.