Skip to content

Commit

Permalink
Added warning for nested lists
Browse files Browse the repository at this point in the history
  • Loading branch information
MartenBE committed Mar 13, 2024
1 parent dd3a7ae commit 207c0ef
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) .
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 207c0ef

Please sign in to comment.