From an empty folder to a rendered document.
This guide takes about fifteen minutes and assumes only that you have Node 18 and a text editor. By the end you will have a project that converts a Markdown file into a web page and a PDF, and you will know where to look when you want more.
The tutorial
- 01
Create a project and install the core
Run npm init -y, then npm install quillmark. Create a file called hello.md and write a heading, a paragraph and a list.
- 02
Render it twice
Write a short script that reads hello.md and calls quill.render for html and for pdf. Run it, and open the two files that appear in your output folder.
- 03
Style it with a theme
Install quillmark-theme-paper, pass it as an option and render again. The same Markdown now has a serif body, numbered headings and running page numbers in the PDF.
- 04
Add one plugin
Install quillmark-tables and add it to the plugins list. Pipe tables in your Markdown now render with borders and align correctly in print.
Packages
The core is small on purpose. Everything else is opt-in.
| quillmark | The renderer for HTML, PDF and EPUB | 41 |
|---|---|---|
| quillmark-tables | Pipe tables with alignment and captions | 6 |
| quillmark-footnotes | Footnotes that turn into endnotes in print | 4 |
| quillmark-diagrams | Flowcharts from text, drawn as SVG | 38 |
| quillmark-highlight | Syntax coloring for 60 languages | 112 |
| quillmark-theme-paper | A print-first theme with page numbers | 18 |
Stuck on the first run?
The PDF is blank.
The PDF renderer needs a bundled browser engine. Run npx quillmark doctor and it will tell you whether the engine is missing and how to install it.
Can I use it without Node?
A command-line binary renders a file without Node being installed. It is built for macOS, Windows and Linux with each release.
Where do I ask a question?
Open a thread in the discussion board. Answers there are searched by people who hit the same problem next month.