Docs: clean up markdown files #449
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Always use the `atx` style headers (`# ...`). * Use consistent blank lines around headers. * No trailing punctuation in headers. * Every file should have a header. * First header in a file should be an H1. Note: the issue templates do not trigger this error as they use frontmatter with a `title` attribute. However, frontmatter is not supported for pull request templates.
* Use the same list markers throughout each document. * Use consistent sublist indentation: each level should be indented by four spaces.
> Rationale: Some Markdown parsers will treat two blockquotes separated by one or more blank lines as the same blockquote, while others will treat them as separate blockquotes.
* No long lines within code blocks.
Rationale: to prevent a horizontal scrollbar.
* All codeblocks should specify the language.
Generally speaking, the "full" table format should always be used - with leading and trailing pipes, but that is a bit awkward for this particular table as a template file like this will typically be edited in a fixed size font, while GH, when using the template to create an issue will use a variable size font. So, this is a bit of a mix-and-match to, yes, use the full table format, but also make it look reasonable when people edit the table in a new issue.
* Code snippets which either _look like markdown_ or could confuse markdown parsers, should be wrapped in backticks.
* Text in square brackets, which is not a link, should escape the square brackets.
* Various (tooling) names should use proper case, except when used in code snippets.
To that end, either fix the case of the term or wrap the code snippet in backticks.
* No blank line within lists.
* No trailing spaces.
Note: especially in the CHANGELOG file, there is a lot more text which should be wrapped in backticks, but that's outside the scope of this current PR, which is aimed at one the one hand preventing markdown parsing problems and on the other hand allowing to run an automated Markdownlint check via CI.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
QA/Markdown CS: use consistent header styles
atxstyle headers (# ...).Note: the issue templates do not trigger this error as they use frontmatter with a
titleattribute. However, frontmatter is not supported for pull request templates.QA/Markdown CS: use consistent list styles
QA/Markdown CS: no consecutive block quotes
QA/Markdown CS: code block consistency
Rationale: to prevent a horizontal scrollbar.
QA/Markdown CS: consistent surrounding pipes for tables
Generally speaking, the "full" table format should always be used - with leading and trailing pipes, but that is a bit awkward for this particular table as a template file like this will typically be edited in a fixed size font, while GH, when using the template to create an issue will use a variable size font.
So, this is a bit of a mix-and-match to, yes, use the full table format, but also make it look reasonable when people edit the table in a new issue.
QA/Markdown CS: various tweaks
To that end, either fix the case of the term or wrap the code snippet in backticks.
Note: especially in the CHANGELOG file, there is a lot more text which should be wrapped in backticks, but that's outside the scope of this current PR, which is aimed at one the one hand preventing markdown parsing problems and on the other hand allowing to run an automated Markdownlint check via CI.
QA/Markdown: fix broken link
QA/Markdown: no duplicate links
Suggested changelog entry
N/A
Related issues/external references
Loosely related to #244