mdf

📢 version 1.1.5: Fixed KaTeX CSS path which leads to broken LaTeX rendering.

Convert Markdown to beautiful PDFs — free, open-source, and zero-config. Welcome to mdf! Please note that this project is currently in the MVP (Minimum Viable Product) stage. Any feedback, suggestions, or contributions are highly appreciated!

Features

• Syntax highlighting — fenced code blocks with language detection (via highlight.js)
• Math formulas — inline and block LaTeX via KaTeX ($...$ and $$...$$)
• Table of contents — insert [TOC] anywhere in your document
• Callout blocks — :::info, :::warning, :::danger, :::success
• Task lists — - [ ] and - [x]
• Tables, images, blockquotes
• Manual page breaks — insert ==page== on its own line
• CJK support — uses Inter + Noto Sans TC via Google Fonts (requires internet on first run)

Installation

Windows

If one hasn't install nodejs, click here to install. After installing nodejs, type

npm install -g @kobekeye/mdf

Linux / macOS

It is highly recommended to use nvm to manage permissions. Using sudo with global npm installs is not recommended.

1. Install nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

2. Install nodejs

nvm install --lts

3. Install mdf

npm install -g @kobekeye/mdf

Usage

mdf input.md              # outputs input.pdf
mdf input.md output.pdf   # custom output name

To watch the output pdf file, use

mdf input.md -w             # outputs input.pdf and watches for changes
mdf input.md output.pdf -w  # custom output name and watches for changes

Or, if you want to try without installation,

npx @kobekeye/mdf input.md               # outputs input.pdf
npx @kobekeye/mdf input.md output.pdf    # custom output name
npx @kobekeye/mdf input.md -w            # outputs input.pdf and watches for changes
npx @kobekeye/mdf input.md output.pdf -w # custom output name and watches for changes

Update

npm update -g @kobekeye/mdf

If you only use npx to run mdf, you don't need to update.

Syntax Guide

Table of Contents

[TOC]

Math

Inline: $E = mc^2$

Block:
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$

Callout Blocks

:::info Title
This is an info callout.
:::

:::warning
Watch out!
:::

:::danger Critical
This is dangerous.
:::

:::success
Operation completed.
:::

Manual Page Break!

==page==

License

MIT