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

pdfkit-markdown

v0.2.0

Published

A markdown renderer for PDFKit using mdast syntax tree.

Downloads

361

Readme

PDFKit Markdown Renderer · npm version

This package provides basic markdown rendering capabilites for PDFKit.

Given a mdast syntax tree as input, content is rendered to a given PDFDocument.

Usage

To render a given markdown string, install:

yarn add pdfkit-markdown unified remark-parse 
import { MarkdownRenderer } from "pdfkit-markdown";
import remarkParse from "remark-parse";
import { unified } from "unified";

...

const tree = unified()
      .use(remarkParse)
      .parse("Markdown **Text**")

new MarkdownRenderer(doc, { /* optional settings */ }).render(tree);

Supported elements

Currently supported elements:

  • Headings
  • Paragraphs and line breaks according to CommonMark specification
  • Bold and italic text
  • List (unordered and ordered)
  • Links
  • Horizontal Rules
  • Code Blocks
  • Inline Code
  • Blockquotes (basic support)

Unsupported elements:

  • Tables
  • Images
  • HTML
  • ...

Configuration

Fonts, sizes, indents etc. are configurable, see documentation on constructor.

Similar packages

https://github.com/maiers/pdfkit-commonmark provides similar functionality, but does not support TypeScript and uses the less maintained CommonMark parser.