Markdown
Paradox source files are written in Markdown, and by convention we prefer the GitHub-flavored style.
We currently use the Pegdown processor to parse Markdown, though this may not remain the case.
Some aspects of our Markdown dialect worth noting are:
- Bulleted lists must always be preceded by an empty line (otherwise they’ll be considered to be a ‘normal’ part of the previous paragraph)
- For references within a paradox tree, we prefer to use the
@ref
directive over Markdown links which introduces opportunities for validation (i.e. use@ref:[Link Text](../other-file.md#some-anchor)
instead of[Link Text](../other-file.html#some-anchor)
).
The source code for this page can be found here.