Skip to content
alextianyfPublic

About

Inkleaf is a free desktop tool for turning Markdown into PDF. Search, preview, export—all on your computer.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Inkleaf — A tool for Markdown lovers. A real PDF with code, mathematics and bilingual text.

Download for Windows  Quick start

Supported system: Windows  Free for personal, noncommercial use

by Alex Tian  ·  English · 简体中文  ·  Roadmap  ·  Feedback

A small space for your next PDF

Inkleaf is a Windows desktop tool for turning Markdown notes, project READMEs and technical documents into PDFs. A shortcut brings up the search bar. Find a file, check the finished pages, and export. No account, subscription or document upload.

Language support: The interface is available in English and Simplified Chinese. Markdown documents and exported PDFs support English, Chinese, and mixed Chinese–English text.

Search Markdown, preview its formula and table, follow a contents link, and export a PDF

Recorded in the real app with a sample document. View a still image.

What you can do

Task How it works
Find a document Search part of a filename or path. Results distinguish Markdown files from folders containing Markdown.
Check before saving Follow preview progress, inspect page breaks and clickable contents, then export the same PDF bytes with a clear success confirmation.
Keep the details Render mathematics, tables, images, aligned badges, callouts, task lists and footnotes. Missing resources and some unsupported content show a visible preview notification with expandable reasons and references.
Convert a folder Select Markdown files for batch export and inspect them individually. Preserve subfolders; automatic output adds numbers to avoid overwriting existing PDFs.
Choose the layout Modern (default), Classic and Minimal themes, A4 or Letter, typography, heading styles, pagination, headers, footers and copyright.
Set app appearance Choose Light, Dark or System in General. App appearance stays independent of your PDF theme.
Keep it local Convert without changing the Markdown source. Save to Downloads, beside the source, or in a folder you choose.

Why Inkleaf?

  • Free for personal, noncommercial use. No subscription, conversion credits or account required for that use. Business and other commercial use require separate written permission; fees are negotiated separately. License.
  • Documents stay on your computer. Conversion runs locally and leaves the Markdown source unchanged. Local resources, bundled mathematics and Modern’s bundled fonts work offline; only remote images and update checks need a connection.
  • Fast filename search. A recorded Windows benchmark measured about 23 ms median query time for 100,000 indexed Markdown files. Initial scanning, startup and displaying results are separate. Measurements and limits.
  • A small interface, a short workflow. Bring up the search bar, choose a file and preview. Inkleaf stays in the system tray between uses.

Markdown, on paper

These comparisons pair the literal Markdown source with PDFs generated by Inkleaf, using the Minimal theme, A4 paper and 10.5 pt body text. Only blank page margins are cropped from the images. Click a comparison to enlarge it; download the PDF to try its links.

Headings and text

All six heading levels, bold, italic, strikethrough, bilingual text and a blockquote.

Markdown and actual PDF: six heading levels, text emphasis, Chinese and English, and a quote

Markdown source · Actual PDF

Code and mathematics

Code preserves its text and indentation, with language-specific syntax highlighting. Modern also adds bundled code fonts, language labels and optional line numbers. KaTeX renders inline formulas, integrals and fractions.

Markdown and actual PDF: JavaScript code, inline math, a Gaussian integral and the quadratic formula

Markdown source · Actual PDF

Tables and lists

Left-, center- and right-aligned table columns, checked and unchecked tasks, numbered steps and nested bullet lists. Task checkboxes are static in the PDF.

Markdown and actual PDF: aligned table columns, task checkboxes and nested lists

Markdown source · Actual PDF

Images, badges and links

Local images and SVG badges follow their paragraph's alignment. Relative references may use shared assets within the nearest Git project; outside local paths are blocked. Standalone Markdown files use their containing folder as the boundary. Missing images show a notice with the reason and reference. The example PDF includes an internal jump, an external link, and a footnote with a return link.

Markdown and actual PDF: centered image and badge, internal and external links, and a footnote

Markdown source and local images · Actual PDF

A reusable quality template covers headings, emphasis, lists, quotes, callouts, code, math, tables, images, HTML and footnotes. Developers can run the PDF and grayscale checks across all three themes.

These are examples of supported content, not a promise of every Markdown dialect. See the compatibility guide for unsupported extensions and layout limits.

Get Inkleaf

Download for Windows (x64) · Release notes

The current stable release is 0.6.1. Download the .exe installer above, or run from source. The .blockmap and latest.yml files on the release page are used by the updater; manual installation only needs the .exe.

The installer bundles the runtime, so Node.js and Python are not needed. macOS and Linux builds are not currently offered, and Windows builds are unsigned. Version 0.6.1 fixes shared project images, adds visible rendering-error notifications, and bundles Noto Sans SC for Chinese text in Modern. Only required font subsets are embedded; Inter and JetBrains Mono remain the Latin and code fonts. Printed page headers/footers and characters outside the bundled repertoire still use system fonts. Modern remains the default; Classic, Minimal and existing theme preferences are preserved.

Installed Windows builds check for new stable versions. You choose Download, then Restart and update when ready. Inkleaf waits for active conversion or export tasks; quitting normally does not install an update. Update and release details.

Make your first PDF

  1. Launch Inkleaf and press Ctrl + Shift + Space.
  2. Type part of a Markdown filename. Select a result and press Enter.
  3. Review the PDF, then click Export PDF. The default destination is Downloads.

Choose a folder result to prepare a batch. Use Esc to dismiss the search bar. Right-click the system tray icon to open Settings or quit the app.

Settings are grouped into General, Search, Layout, Export, and About & updates. Layout uses a fixed sample document for its live preview. Ordinary settings save automatically; Layout requires Save layout and prompts before leaving unsaved changes. All settings.

A few things to know

What does search look through?

Local Markdown filenames and paths, plus folders containing indexed Markdown. The first scan takes time; results appear as files are discovered. Add folders or exclude locations in Settings. Search does not yet include document contents, pinyin or typo correction.

Does conversion work offline?

Yes, for documents using local resources. Mathematics and its fonts are bundled. Modern also bundles its Latin, code and Chinese document fonts; conversion does not download them. Remote images and badges need a connection when fetched, and update checks contact GitHub. The document itself is not uploaded for conversion.

Will every Markdown extension render?

Inkleaf supports common Markdown and selected extensions, including KaTeX math and footnotes. Mermaid, PlantUML, Obsidian wiki links are not implemented. Complex HTML/CSS, very wide tables and formulas may need adjustments. Supported formats and limits.

Will Inkleaf change my source files?

No. Conversion reads your Markdown. Limited formatting recovery happens in memory and reports what changed; it is not a universal Markdown fixer. Source checks.

Behind the name

A printing block can be used again and again. So can a Markdown document.

Inspired by traditional Chinese printing, 印页 brings together the act of printing and the finished page. Inkleaf pairs ink with leaf, a sheet of paper. Keep writing in Markdown; make a PDF whenever it is ready to share.

Still taking shape

The conversion workflow is implemented; the desktop experience is still being refined. The app includes symmetric resizing, a larger layout preview and clear save/change feedback. Further PDF styling, search, conversion speed and code-maintenance improvements are on the roadmap.

If something renders incorrectly, open an issue with the app version, Windows version, a small Markdown example and the expected result. Remove private information before sharing a sample.

License

Copyright © 2026 Alex Tian. Inkleaf uses a custom Personal Noncommercial License, not MIT. Personal use without financial benefit or commercial advantage is free. Internal business use, paid teaching, resale and paid services require prior written authorization, with fees agreed separately.

Your documents and generated PDFs remain yours; the license does not require a watermark. Third-party components retain their own licenses. For authorization, use the contact channels on Alex Tian's profile.

Built with

Electron and React for the desktop app, Markdown-it for parsing, KaTeX for mathematics, Chromium for PDF generation, PDF.js for preview, and highlight.js for code colors. Updates use electron-updater and GitHub Releases.

To run the desktop version locally, install Node.js 22.12 or newer, then:

git clone https://github.com/alextianyf/Inkleaf.git
cd Inkleaf
npm ci
npm run dev

This starts Inkleaf Dev with separate settings and the default shortcut Ctrl + Alt + Shift + Space, so it can run alongside the installed app. In PowerShell, use npm.cmd if npm is blocked by script policy.

The desktop version is available on main. The earlier app is preserved on aldusV1. Command cheat sheet (中文) · Development and builds · Project structure.


印页 · Inkleaf · 让文字成页。
Brand assets · Markdown support · Report an issue

About

Inkleaf is a free desktop tool for turning Markdown into PDF. Search, preview, export—all on your computer.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages