-
Notifications
You must be signed in to change notification settings - Fork 1
Typos and many small formatting topics #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
shining-man
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quite a lot of changes 🙂 I’ve gone through everything, left some comments, and there are a few things (e.g. with the lists) that I didn’t fully understand — could you take a look?
- Corrected markdown structures - German spellchecking
|
Hi @shining-man Thanks for your review and patience with this. Sorry for some of the hiccups - that was totally unintended. To come back to your feedback:
Generally i would advise to use something like pre-commit with a config for markdownlint (including fix) and to establish a common markdownlint config (or any other tool to enforce standards for these docs. My proposal for a .markdownlint.yaml would be: # MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md007.md
MD007:
# Spaces for indent
indent: 4
# Whether to indent the first level of the list
start_indented: false
# Spaces for first level indent (when start_indented is set)
start_indent: 2
# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md
MD012:
# Consecutive blank lines
maximum: 2
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md
MD013: false
MD024: false
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md
MD033: false
MD036: false
MD041: false |
It looks worse than it actually is ;-)