Sync Markdown checks with "template" #101
Merged
Conversation
This file contains hidden or 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
per1234
added
type: enhancement
umbynos
approved these changes
Aug 16, 2021
We have assembled a collection of reusable project assets: https://github.com/arduino/tooling-project-assets These will be used in the repositories of all Arduino tooling projects. Some improvements and standardizations have been made in the upstream "template" assets for checking the general quality of Mardown files. Those are introduced to this repository here. Notable: - Make link check task Windows compatible - Use markdownlint-cli to check for common problems and style. - Bring repository into compliance with the standard Markdown style for Arduino tooling projects NOTE: the `docs:check-links` task has been renamed to `markdown:check-links` for consistency with the standard "template" task name.
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.
We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These will be used in the repositories of all Arduino tooling projects.
Some improvements and standardizations have been made in the upstream "template" assets for checking the general quality
of Markdown files. Those are introduced to this repository here.
Notable:
NOTE: the
docs:check-linkstask has been renamed tomarkdown:check-linksfor consistency with the standard"template" task name.