OpenTabletDriver / opentabletdriver.github.io

The next version of OpenTabletDriver.Web
http://opentabletdriver.net/
GNU Affero General Public License v3.0
1 stars 5 forks source link

Lint markdown in PRs #62

Closed gonX closed 9 months ago

gonX commented 9 months ago

Lints markdown with markdownlint-cli with the GitHub action nosborn/github-action-markdown-cli.

Uses my local fork until a PR is merged that we need: nosborn/github-action-markdown-cli#64

Notes

gonX commented 9 months ago

~~Add how to lint to README: markdownlint --ignore "vendor/" --ignore _includes/tablets.md --ignore _data/plugin-repository/ . 2>&1 | less~~

Added in f1e76ca4b044

Integrating these ignores into the .markdownlint conf is also an option

Doesn't seem like we can actually configure this

gonX commented 9 months ago

Rebased to work with the new Jekyll 4.x deployment

X9VoiD commented 9 months ago

Worth considering if we want to add markdown linting via docker image to avoid pulling node/npm:

docker run -v $PWD:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest "*.md"

example taken from https://github.com/igorshubovych/markdownlint-cli

gonX commented 9 months ago

Worth considering if we want to add markdown linting via docker image to avoid pulling node/npm:

docker run -v $PWD:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest "*.md"

example taken from https://github.com/igorshubovych/markdownlint-cli

Nice, will test which is faster before merging.

X9VoiD commented 9 months ago

I think its current state can be merged now as-is, but I'm leaving that decision to you @gonX since I'm not sure if you still have some other plans for this PR. Fwiw, the docker thing can just be done on a later PR as it doesn't change anything functionally.

gonX commented 9 months ago

Ok, makes sense