<!-- generated by epythet -->

# For AI agents

`pdfdol` ships artifacts for coding agents alongside its code. This page lists
them, says where each lives in the repository, and points at the
machine-readable copies of this documentation.

## Skills

Skills are folders holding a `SKILL.md` (the [Agent Skills](https://agentskills.io) format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with `gh skill` (any host: `--agent claude-code`, `copilot`, `cursor`, `codex`, `gemini`), or use the copy bundled in the wheel.

### `pdfdol-convert`

Convert files, URLs, or raw content to PDF using pdfdol. Use this skill whenever the user wants to convert documents to PDF format – including EPUB, MOBI, DOCX, ODT, HTML, Markdown, images, URLs, or any other file format to PDF. Also use when the user asks about what formats can be converted to PDF, wants to register custom format converters, or needs to check whether Calibre/ebook-convert is available. Triggers on: “convert to pdf”, “make a pdf from”, “epub to pdf”, “save as pdf”, “export to pdf”, “pdf from url”, “screenshot to pdf”, “image to pdf”, “docx to pdf”.

Source: `pdfdol/data/skills/pdfdol-convert` (bundled with the pip package).

### `pdfdol-read`

Read, extract text from, and process PDF files using pdfdol. Use this skill whenever the user wants to extract text from PDFs, read PDF metadata (title, author), access a folder of PDFs as a dict-like store, concatenate or merge multiple PDFs, or do batch PDF operations. Triggers on: “extract text from pdf”, “read pdf”, “pdf to text”, “get pdf title”, “merge pdfs”, “combine pdfs”, “concatenate pdfs”, “pdf metadata”, “pdf folder”, “pdf store”, “batch pdf”.

Source: `pdfdol/data/skills/pdfdol-read` (bundled with the pip package).

The bundled skills are also on disk after `pip install pdfdol`, under the package’s `data/skills/` directory; link them into an agent without network access with `skill link-skills <that directory>`.

## Instruction files

Files agents read before working in this repository.

- `.claude/CLAUDE.md`: read by Claude Code

## Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

- <a href="llms.txt"><code>llms.txt</code></a>: an index of every page with a one-line description ([llms.txt](https://llmstxt.org) format)
- <a href="pdfdol.md"><code>pdfdol.md</code></a>: the whole documentation as one Markdown file
- `<page>.html.md`: a rendered Markdown twin of every page, advertised from each page’s `<head>` with `<link rel="alternate" type="text/markdown">`
- <a href="objects.inv"><code>objects.inv</code></a>: the Sphinx inventory: a symbol-to-URL index (`sphobjinv convert plain objects.inv -`)
