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
Markdown Linting Github Action #250
Conversation
Visit the preview URL for this PR (updated for commit e16ab62): https://fetch-docs-preview--pr250-feat-md-linting-acti-vjfm0vlx.web.app (expires Wed, 14 Sep 2022 17:33:38 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
@VijaySharma815 please address the CI failures. |
Add automated listing of markdown files in the script that generates the reference API. |
I found the python package but it's inactive: also, it uses
|
@5A11 In this PR I already did linting: |
@VijaySharma815 make docs-check and make docs-format commands are added |
This tool requires the introduction of a heavy dependency, either npm and associated JS dependencies, or docker. For such an optional tool, such a move is not justified. For now, a standard python tool is preferred. |
VS code extension:
https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
Rules:
https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md
Md linting tool:
https://github.com/DavidAnson/markdownlint
GitHub actions:
https://github.com/avto-dev/markdown-lint