Markdown Guide
Complete reference for writing and formatting documents in TypDocs.
Markdown Basics
Write your content using standard Markdown syntax. All common elements are supported out of the box.
- Headings — use # through ######
- Lists — use - or 1. for ordered lists
- Bold — wrap text in **double asterisks**
- Italic — wrap text in *single asterisks*
- Inline code — wrap in `backticks`
- Code blocks — use triple backticks with optional language
- Tables — use | pipes | to separate columns |
- Links — [link text](https://url)
Dynamic Placeholders
Use these placeholders in headers, footers, and document body — they are replaced automatically at render time:
{title}Replaced with the first H1 heading of your document{date}Replaced with the current date{page}Replaced with the current page number{pages}Replaced with the total page countPage Breaks
Insert a page break anywhere in your document by adding the following HTML comment on its own line:
<!-- pagebreak -->
Each section separated by this comment will start on a new page when exported.
Exporting as PDF
Click the Export PDF button in the top bar to open your browser's print dialog. Select Save as PDF to download the file. For best results, disable headers and footers in the print dialog — TypDocs handles those for you.