feat: santize markdown links #847
Open
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
liammoat
force-pushed
the
feat/santize-markdown-links
branch
3 times, most recently
from
02bff2d to
c2db0fb
Compare
liammoat
force-pushed
the
feat/santize-markdown-links
branch
from
c2db0fb to
58edf59
Compare
Signed-off-by: Liam Moat <contact@liammoat.com>
liammoat
force-pushed
the
feat/santize-markdown-links
branch
from
58edf59 to
cb0dcdb
Compare
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.
Description of your changes
This pull request updates
sanitizemethod which is used to soothe markdown linters. In particular, the update adds a method to sanitize bare links (a violation of markdownlint rule MD034).Fixes #601
I have:
make test.How has this code been tested
I have test various combinations of edits to the example module, including add bare links in header/footer, output descriptions, and providers. In each scenario, I have validated that bare links are sanitized with <> formatting. For example: