Add Markdown checks#516
Merged
Merged
Conversation
This adds a script which will do some basic Markdown syntax checks (currently only checking for the redundant presence of a redundant h1). It can be run locally, or will run automatically on any open pull requests, with the result being a comment left (or deleted once resolved). Copied from https://github.com/NHSDigital/digital-prevention-services-portfolio/tree/main/.github where we've been testing it out.
Collaborator
Author
|
This would have caught #514 (comment) - so feels like a useful thing to copy across here? We can extend it in future to cover other potential common Markdown issues? |
edwardhorsford
approved these changes
Jun 12, 2026
edwardhorsford
left a comment
edwardhorsford
left a comment
Collaborator
There was a problem hiding this comment.
Tried this locally with the help of Claude, seemed to work.
It suggested that if a fenced code block contained an h1 then this would flag. This could ignore on any fenced code blocks - but I think in practice this is likely a very unlikely scenario for the design history.
Collaborator
Author
|
@edwardhorsford ah good point Claude. But probably unlikely to come up. We can iterate later if needed. Ideas and pull requests on other checks we can make welcome! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds a script which will do some basic Markdown syntax checks (currently only checking for the redundant presence of a redundant h1).
It can be run locally, or will run automatically on any open pull requests, with the result being a comment left (or deleted once resolved).
Copied from https://github.com/NHSDigital/digital-prevention-services-portfolio/tree/main/.github where we've been testing it out.