Skip to content

Conversation

@melissawm
Copy link
Member

@melissawm melissawm commented Oct 27, 2025

References and relevant issues

Closes #821

Description

This PR lints the entire repo. I am using mdformat with myst, and there are some limitations and caveats:

  • Colon fence syntax is not currently supported by the linter. I have tried to separate out these changes in a specific commit so they're easy to revert if we want to (see colon fence syntax is broken by escape character executablebooks/mdformat-myst#13 for context)
  • There are some escapes enforced here (like \[) that we don't really need but I guess they don't hurt and the benefit in the end is a net positive (having the linter turned on by default)
  • I have excluded the naps folder from the linter because the rst syntax for the file metadata creates issues. We can explore if we want to touch those in the future but I don't think they are critical to lint.

Most of the motivation for this is to catch syntax issues early before a contributor actually submits a PR or has to build the docs locally.

Run mdformat with pre-commit. This is a test to see how the formatter behaves.

@melissawm melissawm force-pushed the md-linter branch 3 times, most recently from 2b6f3be to 8a06262 Compare October 27, 2025 06:05
@github-actions github-actions bot added documentation Improvements or additions to documentation maintenance CI, dependencies, and other maintenance labels Oct 27, 2025
@melissawm melissawm marked this pull request as ready for review October 28, 2025 05:05
@psobolewskiPhD
Copy link
Member

Just for my sanity: you first converted all the colon fencing manually or using another tool, and then the normal mdformat was able to work basically?

@melissawm
Copy link
Member Author

Yes, exactly!

@TimMonko TimMonko added this to the 0.7.0 milestone Oct 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation globias hackathon maintenance CI, dependencies, and other maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Find and apply a suitable linter for documentation pages

3 participants