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

Implement "markdownlint" for linting of the docs #150

Open
tarkatronic opened this issue Dec 1, 2020 · 0 comments
Open

Implement "markdownlint" for linting of the docs #150

tarkatronic opened this issue Dec 1, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tarkatronic
Copy link
Contributor

Feature Request

Is your feature request related to a problem? Please describe.

No problem. But more linters and more consistency == more good!

Describe the solution you'd like

There are apparently two markdownlint tools available; one in Ruby (https://github.com/markdownlint/markdownlint), and one in NodeJS (https://github.com/igorshubovych/markdownlint-cli). There is also a (no longer active) pymarkdownlint (https://github.com/jorisroovers/pymarkdownlint).

I'm not really sure the advantages/disadvantages of each. Except that the Python one is incomplete and abandoned. I think it will take some experimentation and perhaps somebody with a strong opinion to decide which to use.

Each has a .pre-commit-hooks.yaml, meaning we can use it with our existing pre-commit toolchain. I guess it's just a matter of, do we want to introduce Ruby or JS to the stack?

Describe alternatives you've considered

The alternative is that I continue manually linting things when I edit the docs, and that sucks. 😄

Teachability, Documentation, Adoption, Migration Strategy

For migration, we can do one fell swoop to get all the docs in compliance with the linter. And then adding it to the pre-commit config will be easy enough. There shouldn't need to be any additional teaching there. The one complication we will have is that I don't know how easily we can integrate this with tox. Might need some thought on that one...

@tarkatronic tarkatronic added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 1, 2020
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant