Add markdownlint #1664
Merged
Add markdownlint #1664
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
martincostello
added
enhancement
documentation
CI/build
dependencies
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1664 +/- ##
=======================================
Coverage 84.63% 84.63%
=======================================
Files 306 306
Lines 6819 6819
Branches 1045 1045
=======================================
Hits 5771 5771
Misses 839 839
Partials 209 209
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Add a markdown linter to the `gh-pages` workflow. Contributes to #1639.
- Add configuration for Markdownlint. - Fix some lint warnings. - Fix incorrect file name.
Despite the docs calling it `.config`, it needs to be `.json`.
Needs to start with `.`.
- Update the path to the config file. - Ignore the CHANGELOG.
Try implicitly using the configuration file.
Try specifying the config file path again.
Fix some Markdownlint warnings.
Turn off MD013 (line-length) completely.
Allow `br`, `img` and `sub`.
martincostello
force-pushed
the
markdown-lint
branch
from
0eb0ab9
to
4fd6f23
Compare
martintmk
approved these changes
Sep 29, 2023
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.
Add a markdown linter to the
gh-pagesworkflow.Contributes to #1639.