Make Static Site Editor list styling consistent with the Handbook Markdown Guidelines
Problem
Editing a page using the Static Site Editor that contains a mixed-style list results in formatting that is not consistent with the Handbook Markdown Guidelines.
Details
A simple example is
1. This is a list item
* This is a sub-item using a bullet
1. This is the second list item
* Another sub-item
1. This should be the third item.
Rendered in the Handbook, it looks like this:
- This is a list item
- This is a sub-item using a bullet
- This is the second list item
- Another sub-item
- This should be the third item.
Rendered in this description block using GFM, however, it looks like:
- This is a list item
- This is a sub-item using a bullet
- This is the second list item
- Another sub-item
- This should be the third item.
This is due to there only being 2 spaces preceding the sub-item asterisk.
A real-world example of this can be found here: https://about.gitlab.com/handbook/product/product-principles/
Solution
Configure the Static Site Editor to format lists adhering to the Handbook-flavored markdown rules:
- List bullet char:
-
- list indent space: 3 spaces
- increment ordered lists:
false
Edited by Enrique Alcántara