Skip to content

Commit 4c0902d

Browse files
authored
General Style Guide: add section about Markdown (#2667)
1 parent 8cb61ce commit 4c0902d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/documenting/general-style-guide.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ A few of the most common cases picked up in reviews are listed below:
2626
- Less content makes tables easier to read.
2727
- When limiting the amount of text is not possible, consider using other data structures for representing the information. For example, lists or `{% configuration_basic %}` can be used.
2828

29+
## Markdown
30+
31+
A few notes about the use of markdown in this documentation:
32+
33+
### Markdown lists
34+
35+
- For unordered lists, use `-`, not `*`.
36+
- For ordered lists, use increasing numbers.
37+
2938
## YAML and templates
3039

3140
We have a separate styling guide for YAML and the use of Jinja2 templates

0 commit comments

Comments
 (0)