Markdown guide
Everything DocAssist understands. Write it in any text editor, then turn it into Word and PDF on the converter.
| What | Write | What you get |
|---|---|---|
| Title block | --- title: My report subtitle: For the board meta: - 2 October 2026 --- At the very top. The title, a line under it, and grey lines such as a date or reference. | At the very top. The title, a line under it, and grey lines such as a date or reference. |
| Sections | ## Section ### Sub section #### Minor heading Word's Heading styles. The Report layout numbers ## sections 1, 2, 3. | Word's Heading styles. The Report layout numbers ## sections 1, 2, 3. |
| Emphasis | **bold**, *italic*, `code`, ~~struck~~ Inside any paragraph, list or table cell. | Inside any paragraph, list or table cell. |
| Links | [the website](https://example.com) Become real links in Word and the PDF. | Become real links in Word and the PDF. |
| Lists | - bullet - nested bullet 1. numbered Indent by two spaces to nest, up to three levels. | Indent by two spaces to nest, up to three levels. |
| Checklists | - [ ] to do - [x] done Tick boxes. | Tick boxes. |
| Tables | | Item | Price | | --- | ---: | | Licence | 1 200 | The first row is the header and repeats on each page. ---: aligns a column right. | The first row is the header and repeats on each page. ---: aligns a column right. |
| Column widths | <!-- widths: 20,50,30 --> <!-- size: 8 --> On the line before a table: relative column widths and the font size. | On the line before a table: relative column widths and the font size. |
| Callout | > The one point not to miss. A highlighted box or bar beside the text. | A highlighted box or bar beside the text. |
| Images |  On its own line. The caption goes under it. Upload the image too, or a zip with the folder. | On its own line. The caption goes under it. Upload the image too, or a zip with the folder. |
| Image width | <!-- width: 9 --> On the line before an image: its width in centimetres. | On the line before an image: its width in centimetres. |
| Code | ``` npm run build ``` A block in a fixed-width font. | A block in a fixed-width font. |
| Divider | --- A line across the page, after a blank line. | A line across the page, after a blank line. |
| Table of contents | <!-- toc --> Lists the ## and ### headings. Word fills in page numbers when the file opens. | Lists the ## and ### headings. Word fills in page numbers when the file opens. |
| New page | <!-- pagebreak --> Starts the next part on a new page. | Starts the next part on a new page. |
Not supported: footnotes, nested tables and inline HTML. They come through as plain text, so they are easy to spot and change.