Skip to content

Conversation

egrace479
Copy link
Member

Applied the linter to the repo and adjusted the rules where needed:

  • Set to ignore mkdocs.yaml and our templates -- these have particular formatting we don't want edited
  • Actually allowed "!" in headers.
  • Allowed code blocks without language specification.
  • Allowed fenced code blocks, as this commonly errors when indented (see discussion).
  • Manually disabled rule for table on part of the command line cheat sheet because it was being trigger through improper recognition by markdownlint (and VS Code), though it renders properly on the site.
  • Manually disabled rule for in-line HTML on the command line cheat sheet page since it is needed for better table formatting and brackets aren't recognized as being in a code block by the linter.

For the record, the linter has consistency within a file, not as much across files (e.g., - vs * as a bullet point). We should now be at the point where an action could be added without causing a major headache.

ignores template pages--these shouldn't be edited and were designed for ease-of-use
ignores mkdocs.yaml
avoid rules that don't work in some locations (e.g., need HTML for table formatting)
linter has consistency within a file, not as much across
@egrace479 egrace479 requested review from hlapp and thompsonmj August 13, 2025 22:31
@egrace479 egrace479 linked an issue Aug 13, 2025 that may be closed by this pull request
Add new settings and linting instructions
Add note that local linting is optional
Copy link
Member

@hlapp hlapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link
Contributor

@thompsonmj thompsonmj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@egrace479 egrace479 merged commit c61bfb8 into dev Aug 15, 2025
@egrace479 egrace479 deleted the lint-repo branch August 15, 2025 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lint entire repo for fresh start
3 participants