Commit bfeab78a authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Change doc styleguide to use quotes for notes

[ci skip]
parent 9a7690f9
......@@ -85,9 +85,19 @@ Inside the document:
## Notes
- Notes should be in italics with the word `Note:` being bold. Use this form:
`_**Note:** This is something to note._`. If the note spans across multiple
lines it's OK to split the line.
- Notes should be quoted with the word `Note:` being bold. Use this form:
```
>**Note:**
This is something to note.
```
which renders to:
>**Note:**
This is something to note.
If the note spans across multiple lines it's OK to split the line.
## New features
......
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