-
Notifications
You must be signed in to change notification settings - Fork 9.7k
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
Find a replacement for marker (markdown linter) #18059
Comments
cc. @jmhbnz |
@ivanvc Can we use markdownlint which is officially on Go.pkg.dev : https://pkg.go.dev/github.com/svendowideit/markdownlint |
It looks like an abandoned project. It was originally done by Docker, but it's now a public archive, and its last commit is from 2017. I think, ideally we should replace it with other linter that has more wide adoption. Their README mentions that it was in use for https://docs.docker.com. However, Docker docs is now using NodeJS' markdownlint: |
Surveying GitHub doesn't seem to be promising. There are some projects, but they seem unmaintained, or abandoned: https://github.com/search?q=markdown linter language:Go&type=repositories |
IMO, it's not related to RUST. It needs a release to publish executable binary. For Go ecosystem, As far as I know, the Is it possible to be considered as an option? upload binary to storage which support anonymous download, like etcd/scripts/install-marker.sh Lines 12 to 15 in bb701b9
Thanks, |
Hey @fuweid, I agree. After researching a native-Go alternative and yielding no results, I'm leaning towards having a linter that we can use as a binary. I opened PR crawford/marker#32 to have However, my original point is that the use-case for
|
@ivanvc Nice!
If we do have new linter requirement, maybe we can file pull request to |
With #18318 merged, I was looking into cleaning up @jmhbnz, thoughts? (or @ahrtr, as I see you were the last to commit to that |
I am not aware of any usage on the |
What would you like to be added?
Right now we're using marker as the markdown linter. However, I see two issues:
README
While trying to fix 2, I opened a PR crawford/marker#32 to be able to use a published binary, rather than building the project itself.
However, it would be better to use a Go-written Markdown linter as alternative.
Why is this needed?
To keep linting markdown files.
The text was updated successfully, but these errors were encountered: