Cropmark

Convert a README or GitHub Markdown file to PDF

Drop a README.md here, or paste its contents, to get a PDF that reads like documentation: highlighted code in 26 languages, tables, task lists, footnotes and links that stay clickable. Cropmark understands GitHub-flavored Markdown, and headings become bookmarks so a long README is easy to navigate.

What carries over

  • Code blocks

    Highlighted by language, with long lines wrapped.

  • Tables and task lists

    Alignment is kept; checkboxes print ticked or empty.

  • Links

    Links to the web and to sections of the document stay clickable.

  • Images from the web

    Badges and screenshots with a full https:// address are included.

Images with a relative path

An image written as ![Screenshot](./docs/screen.png) points at a file in your repository, which Cropmark cannot see, so it is left out of the PDF. Use the image’s full address on GitHub instead, or embed it as a data: URI.

Questions

Do GitHub badges appear?

Yes, when they are images with a full web address, as shields.io badges are.

What about HTML inside the README?

Simple HTML such as <br>, <kbd> and <details> is kept. Scripts in a document are never run.

Are GitHub alerts like > [!NOTE] supported?

They print as ordinary quotes, with the [!NOTE] label shown as text.

Updated .