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

pdfc

v1.0.9

Published

PDF compiler for your source code

Downloads

7

Readme

pdfc

PDF compiler for your source code

Uses Shiki for perfect syntax highlighting and shiki-renderer-pdf to create the PDFs.

semantic-release

Installation

npm install pdfc

Usage

Most uses are through the CLI, but there is a programatic API.

CLI

To compile all files in a directory to PDFs you can use this:

pdfc src

src is the rootDir here, so all paths will be relative to that. You cannot include files outside of the rootDir.

Output is placed in the pdfs directory by default. To change the output directory you can use the -d or --out-dir flag:

pdfc src -d pdf-build

This will compile all files in src by default. If you want to restrict to a subset of files you can use the --include flag:

pdfc src --include "src/**/*.js"

This will compile only the js files in src. The same can be done with the --exclude flag:

pdfc src --exclude "node_modules" --exclude "src/**/*.test.js"

This will exclude all test files from compilation. Note that node_modules should also be excluded here because it is only excluded by default if --exclude is not passed. If include is specified, exclude will apply to the included files.

You can also specify a theme to use with the -t or --theme flag:

pdfc src -t github-light

If none if specified, it will default to light-plus. See shiki docs for a list of themes.

Run pdfc --help for more on what you can do.

API

Please note that this package is pure ESM, see this for more details.

Compile PDFs, this will also write files to pdfs by default:

import { compilePdfs } from 'pdfc'
;(async () => {
  await compilePdfs({
    rootDir: 'src',
    include: ['src/**/*.js'],
    theme: 'light-plus',
  })
})()

Compile string to a PDFDocument instance:

import fs from 'node:fs/promises'
import { stringToPdf } from 'pdfc'
;(async () => {
  const code = 'console.log("Hello World")'

  const pdfDocument = await stringToPdf(code, {
    lang: 'js',
    theme: 'light-plus',
  })

  const pdfBytes = await pdfDocument.save()
  await fs.writeFile('hello-world.pdf', pdfBytes, 'binary')
})()

Read more about what you can do with pdfDocument here.