npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nota-cli

v1.1.1

Published

Command line interface for Nota

Downloads

8

Readme

Nota CLI

A command line interface to Nota.

Nota eats your HTML based static or scripted template, allows you to mix in your data and excretes pretty PDF documents. Perfect for automating things like invoice or ticket generation, but also a convenient tool rendering a simple static document to PDF.

Usage

Nota has lot of handy CLI options. Try running in the root:

nota --list

You'll see Nota comes with a few example templates out of the box. Try:

nota --template=example-invoice

When finished Nota has rendered a simple PDF page, consisting of some custom rendering of preview data as declared in the template's nota.json file. Change the company logo image and try modifing the example data to see how easy it is to customise it and create your own invoice. If you have a template that needs data and you'd like to render save with a specific filename to a certain location, try this:

nota --template=example-invoice --data=<path> --output=<path>

Web interface

Run Nota as a webservice, and create your PDF's though a friendly UI where you can upload a JSON file and get a PDF in return. Or use the REST API to expose Nota over your the interwebs or LAN (or VPN). Send a POST request with JSON, and get a PDF download in return. Try in your shell:

nota --template=example-invoice --listen

Development previewing

Develop and debug while feeling right at home in your favorite browser, with a 1:1 preview of what Nota turns into a PDF for you. Nota makes designing and programming your documents a breeze with some ready examples that automagically compile CoffeeScript and SASS. Try in your shell:

nota --template=example-invoice --preview
cd templates/examples-invoice && grunt

And you're ready to start customizing!

Prerequisites

You will need the following things properly installed on your computer.

Setup

Due to some shortcomings (see Known problems) in the depencencies that are still being worked out, Nota is a bit picky on it's environment and dependencies. We recommend running Nota under Linux, and we've made a provisioning script that sets up all dependencies for Linux (and unverified support for Mac and Windows under cywin).

chmod +x provision.sh
./provision.sh