agentleFS
Sign inStart free
WeAIClubWeAIClub/md-to-pdf/AGENTS.md

md-to-pdf

AGENTS.md0 starsChanged 3 months agoMITView on GitHub

Guide for AI coding agents (Gemini CLI, Codex CLI, Qoder IDE, Cursor, etc.) to use this project. Converts a Markdown file into a beautifully typeset PDF via a pandoc → Typst pipeline. Ships with two built-in themes (claude-white and claude-white-bold) and bundled fonts. Invoke this tool when the user asks for any of: - "turn this md into a pdf" - "export X.md as pdf" - "make X.md printable / presentable / nicely formatted" - any request to produce a…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before invoking, confirm both dependencies are on PATH and pandoc is at least version 3.2 (the Typst writer was added in 3.2):

    line 40
  2. Distinctive:

    If either is missing — or pandoc is older than 3.2 — tell the user to install / upgrade them (see README for platform-specific commands).

    line 47

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

Guide for AI coding agents (Gemini CLI, Codex CLI, Qoder IDE, Cursor, etc.) to use this project.

What this project does

Converts a Markdown file into a beautifully typeset PDF via a pandoc → Typst pipeline. Ships with two built-in themes (claude-white and claude-white-bold) and bundled fonts.

When to use it

Invoke this tool when the user asks for any of:

  • "turn this md into a pdf"
  • "export X.md as pdf"
  • "make X.md printable / presentable / nicely formatted"
  • any request to produce a polished PDF from a Markdown source

How to invoke

The main entry point is a single shell script:

./scripts/md_to_pdf.sh <input.md> <output.pdf> [theme]
  • input.md — path to the Markdown file (absolute or relative)
  • output.pdf — destination PDF path
  • theme (optional) — defaults to claude-white. Also available: claude-white-bold (stronger bold)

Example:

./scripts/md_to_pdf.sh ./my-doc.md ./my-doc.pdf
./scripts/md_to_pdf.sh ./my-doc.md ./my-doc.pdf claude-white-bold

On success, prints [OK] /absolute/path.pdf.

Preflight checks

Before invoking, confirm both dependencies are on PATH and pandoc is at least version 3.2 (the Typst writer was added in 3.2):

command -v pandoc && pandoc --version | head -1
command -v typst

If either is missing — or pandoc is older than 3.2 — tell the user to install / upgrade them (see README for platform-specific commands). The script will also error out with a clear message.

Fonts are bundled in fonts/; no system-font installation is needed — the script passes them to typst via --font-path.

For a new Mac, keep the repository at ~/Documents/Projects/md-to-pdf and run scripts/setup_new_mac.sh. It links both Codex (~/.agents/skills) and Claude Code (~/.claude/skills) to this checkout, preventing copied installs from drifting.

Platforms

  • macOS and Linux: fully supported
  • Windows: not officially supported (bash script); Git Bash or WSL should work but is not tested

Adding a new theme

  1. Create themes/<your-theme>/theme.typ
  2. Define all required #set and #show rules (see themes/claude-white/theme.typ as reference)
  3. Invoke with ./scripts/md_to_pdf.sh input.md output.pdf <your-theme>

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free