jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-31 13:07:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

General Style Guide: add section about Markdown (#2667)

Browse Source
This commit is contained in:
c0ffeeca7 2025-05-14 18:47:18 +02:00 committed by GitHub
parent 8cb61ce6c3
commit 4c0902db8b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/documenting/general-style-guide.md
View File

@ -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. - 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. - 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 ## YAML and templates
We have a separate styling guide for YAML and the use of Jinja2 templates We have a separate styling guide for YAML and the use of Jinja2 templates