Add markdown linter and fix linter errors #117
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
michaelin
force-pushed
the
update-docs
branch
5 times, most recently
from
f8105fa to
afa4c16
Compare
This adds a new GitHub Action to lint all markdown files in the project. A configuration file limits line lengths to 100 charactes (default is 80) and excludes code blocks and tables from this limit. It also allows the <details> and <summary> tags, since there are no good alternatives. Linting is disabled for anything in `/old` and `/scenarios`. Finally vscode will suggest adding the markdownlint extension when opening the project. This will help vscode users to get linting warnings _before_ committing.
This fixes the existing markdownlint errors that are _not_ related to line length. Those will be dealt with separately, since word wrapping may be a controversial subject.
michaelin
force-pushed
the
update-docs
branch
from
afa4c16 to
85c0ef9
Compare
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.
No description provided.