docs: prettier format markdown documents #1375
Merged
+61
−42
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.
Situation
Top-level Markdown documents in this repo are checked with the script
check:markdown
for hyperlink errors. There is however no check for consistent formatting implemented, leaving Markdown source formatting inconsistencies in the documents.Prettier's support for Markdown is available and unused.
Change
To ensure consistent Markdown document source formatting as part of an overall effort to increase linting coverage in the repo:
Add a script
format:markdown
to fix all formatting of Markdown documents with PrettierAdd a script
format:markdown:check
to check all Markdown documents with Prettier for use in CIAdd .prettierignore with an exception for LICENSE.md since this file is essentially sourced externally and should not be automatically re-formatted.
Add instructions to CONTRIBUTING to format Markdown documents
Add
format:markdown:check
to the .github/workflows/check-markdown.yml workflow.Correct all formatting of Markdown documents.
Verification
Local
22.04.2
LTSNode.js
22.14.0
LTSExecute
CI
Run .github/workflows/check-markdown.yml