Verified Commit e4522327 authored by Camil Staps's avatar Camil Staps 🙂

Add ``` to documentation markup documentation

parent fe7c420d
...@@ -69,9 +69,12 @@ fields. For example: ...@@ -69,9 +69,12 @@ fields. For example:
### Markup in documentation ### Markup in documentation
Some simple markup is allowed in documentation: Some simple Markdown-inspired markup is allowed in documentation:
- `` `foo` `` renders `foo` in monospaced font. - `` `foo` `` renders `foo` in monospaced font.
- Code blocks can be surrounded by `` ``` `` on separate lines. The start of a
code block can indicate the language (for highlighting purposes), as in
`` ```clean ``.
- `{{bar}}` marks `bar` as a defined entity (that can be searched for). - `{{bar}}` marks `bar` as a defined entity (that can be searched for).
- Double newlines distinguish paragraphs; single newlines are ignored unless - Double newlines distinguish paragraphs; single newlines are ignored unless
followed by a hyphen. followed by a hyphen.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment