oam/knowledge base/markdown.md

Markdown

ReadMe's Markdown engine.

Table of contents

1. Troubleshooting
   1. Escape the backtick character
2. Further readings
3. Sources

Troubleshooting

Escape the backtick character

Include a non-code formatted backtick by escaping it normally (with a \).

Render it in an inline code block using double backticks instead of single backticks.

Alternatively, use a code block. This will wrap everything in a <pre> HTML tag.
To do this, either indent 4 spaces to start a code block, or use fenced code blocks if supported.

Further readings

• Official documentation
• Linguist supported language syntax list

Sources

All the references in the [further readings] section, plus the following:

• Escaping Backticks
• Escaping backtick in Markdown