mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-30 04:36:29 +00:00
General Style Guide: add section about Markdown (#2667)
This commit is contained in:
parent
8cb61ce6c3
commit
4c0902db8b
@ -26,6 +26,15 @@ A few of the most common cases picked up in reviews are listed below:
|
||||
- Less content makes tables easier to read.
|
||||
- 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.
|
||||
|
||||
## Markdown
|
||||
|
||||
A few notes about the use of markdown in this documentation:
|
||||
|
||||
### Markdown lists
|
||||
|
||||
- For unordered lists, use `-`, not `*`.
|
||||
- For ordered lists, use increasing numbers.
|
||||
|
||||
## YAML and templates
|
||||
|
||||
We have a separate styling guide for YAML and the use of Jinja2 templates
|
||||
|
Loading…
x
Reference in New Issue
Block a user