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 file linter #4245

Open
jhlegarreta opened this issue Oct 1, 2023 · 0 comments
Open

Add Markdown file linter #4245

jhlegarreta opened this issue Oct 1, 2023 · 0 comments
Labels
type:Style Style changes: no logic impact (indentation, comments, naming)

Comments

@jhlegarreta
Copy link
Member

jhlegarreta commented Oct 1, 2023

Description

Add a Markdown file linter, such as prettier.

Expected coding style

ITK contains numerous Markdown files that e.g. describe how to create content links, the ITK release procedure, etc. Adding a Markdown linter tool (e.g. through pre-commit hooks and GHA workflows) would improve readability across such files by standardizing the style.

Actual coding style

No Markdown linter is in place.

Versions

master.

Additional Information

Additionally, as some of these files may contain duplicate links, it would be nice to put all links in a single Markdown file, and to be able to include such file in other Markdown files so that the links can be reused. It would reduce maintenance, as links would need to be changed at a single place.

As an example, the reStructuredText syntax contains the include directive that allows to do this:
https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment

@jhlegarreta jhlegarreta added the type:Style Style changes: no logic impact (indentation, comments, naming) label Oct 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Style Style changes: no logic impact (indentation, comments, naming)
Projects
None yet
Development

No branches or pull requests

1 participant