0.3.2-0 • Published 10 months ago

@jzetlen/remark-pdf v0.3.2-0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

remark-pdf

npm check demo

remark plugin to compile markdown to pdf.

🚧 WIP 🚧

This project is aiming to support all nodes in mdast syntax tree, but currently transformation and stylings may not be well.

If you have some feature requests or improvements, please create a issue or PR.

  • paragraph
  • heading
  • thematicBreak
  • blockquote
  • list
  • listItem
  • table
  • tableRow
  • tableCell
  • html
  • code
  • yaml
  • toml
  • definition
  • footnoteDefinition
  • text
  • emphasis
  • strong
  • delete
  • inlineCode
  • break
  • link
  • image
  • linkReference
  • imageReference
  • footnote
  • footnoteReference
  • math
  • inlineMath

Demo

https://inokawa.github.io/remark-pdf/

Install

npm install remark-pdf

Usage

Browser

import { unified } from "unified";
import markdown from "remark-parse";
import pdf from "remark-pdf";
import { saveAs } from "file-saver";

const processor = unified().use(markdown).use(pdf, { output: "blob" });

const text = "# hello world";

(async () => {
  const doc = await processor.process(text);
  const blob = await doc.result;
  saveAs(blob, "example.pdf");
})();

Node.js

import { unified } from "unified";
import markdown from "remark-parse";
import pdf from "remark-pdf/node";
import * as fs from "fs";

const processor = unified().use(markdown).use(pdf, { output: "buffer" });

const text = "# hello world";

(async () => {
  const doc = await processor.process(text);
  const buffer = await doc.result;
  fs.writeFileSync("example.pdf", buffer);
})();

Documentation

Related projects

0.3.0

10 months ago

0.3.2-0

10 months ago

0.3.1

10 months ago

0.2.0

11 months ago

0.1.1

11 months ago

0.1.0

11 months ago