Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown linter #6181

Merged
merged 12 commits into from
May 2, 2024
Merged

Markdown linter #6181

merged 12 commits into from
May 2, 2024

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented May 1, 2024

What

Adding a very basic markdown linter. Currently covers only a few issues.

Running pixi run mdlint will check all markdown files in the current directory.

Every error has an error code, which can be used to explain the error via pixi run mdlint --explain {code}.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

To run all checks from main, comment on the PR with @rerun-bot full-check.

Copy link

github-actions bot commented May 1, 2024

Deployed docs

Commit Link
6a52bce https://landing-cmipk1y08-rerun.vercel.app/docs

@jprochazk jprochazk marked this pull request as ready for review May 1, 2024 21:08
@teh-cmc teh-cmc self-requested a review May 2, 2024 08:05
@jprochazk jprochazk merged commit 5b0dbb5 into main May 2, 2024
29 of 36 checks passed
@jprochazk jprochazk deleted the jan/markdown-linter branch May 2, 2024 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check our markdown files for syntax errors
2 participants