From 207c0ef9df4d814e27fe7bbcb47578e7c841843f Mon Sep 17 00:00:00 2001 From: Martijn Saelens Date: Wed, 13 Mar 2024 11:29:59 +0100 Subject: [PATCH] Added warning for nested lists --- README.md | 2 ++ requirements.txt | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b3242b2..54755ef 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,8 @@ An [editorconfig](https://editorconfig.org/) config has been added in [.editorco A [prettier](https://prettier.io/docs/en/) config has been added in [.prettierrc.json5](./.prettierrc.json5) . +:warning: Use 4 spaces for indentation of nested lists. Otherwise the nesting may not work. This is consistent with the [original MarkDown](https://daringfireball.net/projects/markdown/syntax#list) and the [CommonMark](https://spec.commonmark.org/0.31.2/#lists) specs. + ### Linting A [markdownlint](https://github.com/DavidAnson/markdownlint) config has been added in [.markdownlint.jsonc](./.markdownlint.jsonc) . diff --git a/requirements.txt b/requirements.txt index 5e4026e..d345b48 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs +mkdocs-git-revision-date-localized-plugin mkdocs-material -pymdown-extensions mkdocs_puml -mkdocs-git-revision-date-localized-plugin +pymdown-extensions