Add markdownlint to ensure consistent formatting #14
+107
−56
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
michaelin
requested review from
moller2866,
housa,
sofusalbertsen and
Gertmeister
as code owners
A new linting job has been added to the PR workflow, and both workflows now triggers on changes to themselves as well as all markdown files in the root directory and Hugo dirs.
All default MarkdownLint rules are enabled except for MD013/line-length. This rule is often debated, and its value is dependent on your editors word wrap features and configuration.
michaelin
force-pushed
the
markdownlint
branch
from
81f4f28 to
d8304f6
Compare
housa
approved these changes
Mar 5, 2025
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.
I've seen too many places where markdown becomes hard to read over time due to different peoples preferences wrt. formatting and style. Starting out with a unified formatting strategy can lessen this problem.
I've added a GitHub Action for validating all markdown in the repo and a small
.markdownlint.yamlconfig file with all defaults except for disabling line length requirements. We can discuss further changes from there.