DocInsight supports standard Markdown syntax and common GitHub Flavored Markdown extensions. This topic covers the syntax used most often in product documentation; the other topics in this section describe DocInsight-specific authoring features.

Separate paragraphs with a blank line. Use a trailing backslash or two trailing spaces when you need a hard line break inside a paragraph.

Source

This is one paragraph with _emphasis_, **strong emphasis**,
~~strikethrough~~, and `inline code`.

This is another paragraph.\
This line starts after a hard line break.

Result

This is one paragraph with emphasis, strong emphasis, strikethrough, and inline code.

This is another paragraph.
This line starts after a hard line break.

Use ATX headings with one to six # characters:

# Topic title

## Main section

### Subsection

Use one H1 as the topic title. Use H2 through H6 to organize sections within the topic. See Markdown topics for DocInsight title behavior.

Use hyphens for unordered lists and numbers for ordered lists:

- Markdown topics
- Delphi API reference
- Project assets

1. Check the documentation.
2. Build the selected target.
3. Open the generated output.

Indent a list item to create a nested list. Use task-list markers when items have a checked state:

Source

- [x] Configure the project
- [ ] Write the documentation
- [ ] Build the output

Result

• Configure the project

• Write the documentation

• Build the output

Prefix quoted content with >:

Source

> Generated files should not be edited by hand.

Result

Generated files should not be edited by hand.

Use a callout instead when the content is a note, tip, important notice, warning, or danger message rather than a quotation.

Use a header row and delimiter row to create a table:

Source

| Field     | Purpose                       |
| :-------- | :---------------------------- |
| `root`    | Markdown content root.        |
| `exclude` | Files removed from discovery. |

Result

Field	Purpose
root	Markdown content root.
exclude	Files removed from discovery.

In the delimiter row, :--- aligns a column left, ---: aligns it right, and :---: centers it.

Use three or more hyphens on a line by themselves to separate parts of a topic:

Source

---

Result

---

Use an HTML comment to leave information for authors without adding it to the generated HTML:

Source

<!-- Explain why this section is intentionally empty. -->

Result

No visible output is generated.