Follow stricter code style for markdown

dehesselle commented 4 years ago

With this PR I propose to follow stricter code style for markdown. I know that things like that are also a matter of taste and up for discussion, so feel free to disregard this PR.

I use the markdownlint and Trailing Spaces extensions and modified the readme accordingly.

Most notable changes:

only one top level heading allowed (and must be in line 1)
blank line after a heading
blank lines around lists (like this one) and dashes for list items (instead asterisks)
2 trailing spaces to make a paragraph only required if next line is not a newline

rfuehrer commented 4 years ago

let's have a chat (via PM) about implementing a pre-commit check to make sure further edits will follow your intention/issue.

rfuehrer commented 4 years ago

The changes are implemented by the branch rfuehrer/documentation. I have taken your comments and already implemented them in the english translation and the file REASDME_en.md (german original). Thanks for your PR. I will send you a PR to integrate the branch.

generaliinformatik / mycoradar

Follow stricter code style for markdown #5