Lint markdown in PRs #62
Merged
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
gonX
added
enhancement
This comment was marked as outdated.
This comment was marked as outdated.
This was referenced Nov 30, 2023
Merged
gonX
force-pushed
the
workflows-lint-markdown
branch
3 times, most recently
from
34fea04
to
9698d1f
Compare
|
Rebased to work with the new Jekyll 4.x deployment |
Also adds a .markdownlint.yaml file for use with markdownlint-cli We use a fork for the markdown-cli action The original action uses an old version of markdownlint-cli that triggers some false-positives with MD051 that doesn't support predefined ID's for sections
gonX
force-pushed
the
workflows-lint-markdown
branch
from
9698d1f
to
8e9d4ab
Compare
This is a hack to get some specific styling on the website Currently the hack lexer supports '#' comments, anything else is parsed as text
X9VoiD
requested changes
Dec 3, 2023
|
Worth considering if we want to add markdown linting via docker image to avoid pulling node/npm:
|
Nice, will test which is faster before merging. |
Co-authored-by: Oscar Ivan Silvestre <[email protected]>
Co-authored-by: Oscar Ivan Silvestre <[email protected]>
X9VoiD
approved these changes
Dec 3, 2023
|
I think its current state can be merged now as-is, but I'm leaving that decision to you @gonX since I'm not sure if you still have some other plans for this PR. Fwiw, the docker thing can just be done on a later PR as it doesn't change anything functionally. |
|
Ok, makes sense |
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.
Lints markdown with
markdownlint-cliwith the GitHub action nosborn/github-action-markdown-cli.Uses my local fork until a PR is merged that we need: nosborn/github-action-markdown-cli#64
Notes
Fragments to other pages does not seem to be verified (e.g.less of a concern with workflows: Add HTML Verification #76{% link /index.md %}#myid %})<ol>'s are not linted for indentation. We can't reasonably lint for this even with a custom rule so I've tried to make sure code blocks are indented correctly with this PR.