Skip to content

Conversation

@martincostello
Copy link
Member

Add a markdown linter to the gh-pages workflow.

Contributes to #1639.

@martincostello martincostello added enhancement documentation CI/build dependencies Pull requests that update a dependency file github_actions Pull requests that update GitHub Actions code labels Sep 29, 2023
@codecov
Copy link

codecov bot commented Sep 29, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (e21aec3) 84.63% compared to head (4fd6f23) 84.63%.

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           
Flag Coverage Δ
macos 84.63% <ø> (ø)
windows 84.63% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/build dependencies Pull requests that update a dependency file documentation enhancement github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants