Markdown Validation
See original GitHub issueI’m trying to integrate some basic markdown parsing / validation in my build process which is used to validate a hand-written CHANGELOG.md file. From time to time I see colleagues make small mistakes where I wish I’d have a tool that would automatically flag these issues and break my build, things like invalid links (Foo(https://...)
instead of ([Foo](https://...)
), missing whitespace (-something
instead of - something
), stuff like that.
Is there any kind of “strict” option in the parser that I missed where the parser would bail out on inconsistencies / issues like this? If not, would it be feasible to implement such a thing or is the markdown spec too loose for any validation check?
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (3 by maintainers)
Top Results From Across the Web
mattbriggs/markdown-validator - GitHub
Validate and parse document structure created in markdown. Validation uses a set of declarative rules. Formats assume markdown used with static such ...
Read more >Validate your Markdown files | DocFX website - NET
Validate your Markdown files. In Markdown, it is possible to write any type of content, as long as the used syntax is valid....
Read more >Validate Markdown Files With MarkdownLint - Matthew Setter
How do you know that your Markdown content is valid? You use MarkdownLint! In this post, I step through how to install, configure, ......
Read more >Automatic Validation in Markdown Documents
Markdown documents are validated automatically as you type. The conversion engine constantly tries to parse your changes to display the results in the ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@realdadfish, as a future implementation you can make the rules extensible so that a
RegEx
based validator is available and applied toNode
viaNode.getChars()
, other node specific validators can beRegEx
based or code based for maximum flexibility and would specify node classes to which they apply.Then the configuration would consist of configuring a list of rules and visiting the document.
OK, thanks for the pointers, I’ll see with what I can come up with. Will close this for now. Thanks again!