docs: Fix nested list

[itsdonnix]

Q	A
Documentation	yes
Bugfix	no
BC Break	no
New Feature	no
RFC	no
QA	no

Description

Fix nested lists

[Xerkus]

Lists are already valid and correctly formatted with 2 spaces indentation.

Markdown spec allows up to 3 extra leading spaces that are ignored and stripped. We, however, do not allow them for uniformity.

[froschdesign]

@Xerkus
But for some reason, MkDocs only works with 4 spaces.

Some background: Python-Markdown/markdown#3

[Xerkus]

@froschdesign I found mkdocs/mkdocs#2719 (comment)

looks like I added mdx_truly_sane_lists into the markdown extension and that changed the indent to 2 spaces instead of 4.

Can it be fixed in our docs builder with that?

[froschdesign]

@Xerkus
I'm already searching for it…

[Xerkus]

@froschdesign reading your link, I understand mkdocs is not using commonmark?

[froschdesign]

MkDocs uses Python-Markdown:

Indentation/Tab Length

The syntax rules clearly state that when a list item consists of multiple paragraphs, “each subsequent paragraph in a list item must be indented by either 4 spaces or one tab” (emphasis added). However, many implementations do not enforce this rule and allow less than 4 spaces of indentation. The implementers of Python-Markdown consider it a bug to not enforce this rule.

This applies to any block level elements nested in a list, including paragraphs, sub-lists, blockquotes, code blocks, etc. They must always be indented by at least four spaces (or one tab) for each level of nesting.

https://python-markdown.github.io/#differences

[Xerkus]

Can't be merged until linter is updated to allow/require 4 space indentation for nested lists as otherwise it will cause CI failures everywhere.

[Xerkus]

@itsdonnix markdown lint was updated. Can you please also fix remaining nested lists?

[itsdonnix]

@itsdonnix markdown lint was updated. Can you please also fix remaining nested lists?

Sure @Xerkus ! I forgot to indenting the v1 application section and the readme.

[itsdonnix]

I think the CI only checks for the readme file

[Xerkus]

@itsdonnix Thank you. I was totally unaware.