Everyone can contribute
Fixing a typo counts. So does improving an error message, translating a page or answering a question in the discussion board. New contributors are paired with a reviewer on their first pull request.
Open source · MIT license · TypeScript
Write in Markdown. Publish anything.
Quillmark is a free library that turns Markdown into web pages, PDFs and e-books from a single source. It is maintained by nine volunteers, used in more than four thousand projects, and documented here by the people who write the code, with a guide for every first-time contributor.
The project in numbers
- People who have contributed code or docs
- 312
- Active maintainers, all volunteers
- 9
- Projects that depend on Quillmark
- 4,200
- Releases since the first version
- 38
Run it in two minutes
- 01
Install the package
Run npm install quillmark in any project that uses Node 18 or newer. The core has no runtime dependencies and weighs 41 kilobytes.
- 02
Convert a file
Call quill.render with a Markdown string and the target format. The same call returns HTML, a PDF buffer or an EPUB file.
- 03
Add a plugin when you need one
Tables, footnotes, diagrams and syntax highlighting are separate packages, so you only ship the ones you use.
How the project is run
Big changes begin as proposals
A change to the public API starts as a written proposal that anyone can comment on for at least two weeks. Accepted proposals are kept in the repository with the discussion that shaped them.
Meet in person, sometimes
Contributors gather twice a year for a working weekend, and local meetups run in Berlin, Lagos, Seattle and São Paulo. Each one is open to anyone who has opened an issue or just wants to listen.
The release train
Quillmark follows semantic versioning and publishes on a predictable schedule.
- Every Monday
Patch releases · x.y.Z
Bug fixes and documentation corrections, published as soon as the tests pass. Never contains a breaking change.
- First week of each quarter
Minor releases · x.Y.0
New features and plugins, with release notes written before the code is merged.
- About once a year
Major releases · X.0.0
Breaking changes only after a public proposal, a release candidate and a migration guide that has been tried on real projects.
Common questions
Is Quillmark really free to use at work?
Yes. The MIT license lets you use, change and ship it in commercial products. You only need to keep the copyright notice in your distribution.
Who pays for the project?
Donations to the project fund pay for hosting, a security audit each year and a stipend for the release manager. Spending is published every quarter.
How do I report a security problem?
Write to the private address in the security policy. Two maintainers acknowledge reports within 48 hours and agree a disclosure date with you.
The Quillmark dispatch
A short note after each minor release: what changed, who built it and how you can help with the next one.