Markdown support

Doxyte uses the yuin/goldmark library for converting Markdown sources to HTML. This means that CommonMark syntax is fully supported.

You can also use the following extensions:

• Attributes on headings:

  ## Heading {#id .class attr=value}
  

  Note that an ID is automatically generated for every heading. You can override this ID by supplying your own as an attribute.

• Definition lists

• Footnotes

• Tables

• Task list items

• Typographic punctuation substitutions:

  [a's 'a' "a" <<a>> -- --- ...] → [a’s ‘a’ “a” «a» – — …]

Syntax highlighting

To get syntax highlighting for a code block, provide the language after the opening code fence (and remember the setting in the config). For example:

```python
print("Hello")
```

Other HTML features

If you need any HTML features that are not supported by this dialect of Markdown, you can include raw HTML in your source document: it will get passed through unchanged. (For some examples, search for “aside”, “figure”, and “script” in the sources for this site).

NB: This means that Doxyte should not be used to transform untrusted input. E.g. don’t use it in a web service where strangers on the internet can upload source documents.