Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdown lint #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add markdown lint #13

wants to merge 1 commit into from

Conversation

ajpl
Copy link

@ajpl ajpl commented May 16, 2020

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:

  • Enforce the first line to be a heading (more info)
  • Restrict the line length to 120 chars (more info)

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!

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.

1 participant