From 4c0902db8b43891638a23c0778716fdf5ed10de4 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 14 May 2025 18:47:18 +0200 Subject: [PATCH] General Style Guide: add section about Markdown (#2667) --- docs/documenting/general-style-guide.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/documenting/general-style-guide.md b/docs/documenting/general-style-guide.md index 19460227..5c788f34 100644 --- a/docs/documenting/general-style-guide.md +++ b/docs/documenting/general-style-guide.md @@ -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