simonw / til

Today I Learned
https://til.simonwillison.net
Apache License 2.0
1.02k stars 81 forks source link

Add markdown lint #13

Open ajpl opened 4 years ago

ajpl commented 4 years ago

I noticed that there is no linter enabled for the Markdown files. Thus, if you forget to add a proper heading at the top of a md file you'd be "ruining" the README generation process.

I added a workflow that triggers on PRs with very relaxed rules:

For a complete list of rules you can take a look over here.

Rules can be easily modified by changing the .markdownlint file.

Led me know if you find this useful or if you think the rules should be different.

Thanks!