Steps for a README
- Press Open .md file and choose README.md. You can also drag the file onto the editor.
- Pick the Technical theme. It uses tighter spacing and a code style close to the one on GitHub.
- Press Insert contents if the README is long and has no table of contents.
- Turn on page numbers, then press Download PDF and choose Save as PDF.
What READMEs use, and what happens to it
- Code blocks keep their colors. Name the language after the three backticks.
- Tables print with borders. The header row repeats when a table runs onto the next page.
- Task lists print as open and checked boxes.
- Alert blocks such as NOTE and WARNING print with a colored bar.
- Badges and images show if their address allows hotlinking. A badge that fails to load shows its alt text instead.
- HTML such as details and kbd works. Unsafe HTML is removed.
Relative links and images
A README often points to files in the repository, such as ./docs/setup.md or ./img/logo.png. A browser has no repository, so those paths cannot load. Replace them with full web addresses before you convert. A raw GitHub address works for images.
Links to headings inside the README work. [Install](#install) jumps to the heading named Install, in the preview and in the PDF.
Long code lines
Long lines wrap inside the code block instead of running off the page. Short blocks stay on one page. A block of more than about 38 lines is allowed to split across pages.