Add markdown linter and formatter to pre-commit #54
Conversation
github-actions
bot
added
the
documentation
Czaki
force-pushed
the
add_linter_and_formater
branch
from
d5bb4a8 to
833ec22
Compare
|
@jni This is only adding pre-commit and fixing the formating of a few files. Do you think that it is a good way? Should I continue? |
|
Hi @Czaki - is there anything we can do to move this PR forward? |
|
As you may see, I was waiting on any response if people think that such a contribution is valuable. If Yes then I should revisit the list of pre-commit hooks as the current list of markdown liter is longer. |
Czaki
force-pushed
the
add_linter_and_formater
branch
from
833ec22 to
032206a
Compare
|
@melissawm recreated |
|
I will add this to the documentation working group meeting agenda (next meeting is tomorrow, August 2) |
|
here is style described: https://mdformat.readthedocs.io/en/stable/users/style.html |
| --- | ||
| ______________________________________________________________________ | ||
|
|
||
| theme: | ||
| metaDescription: napari is a fast multi-dimensional image viewer for Python. It can help you **explore** any image-like data, be it 2D, 3D, or even higher-dimensional. It can also help you **overlay** downstream or **associated data**, such as point coordinates or segmentations, which you can use to **annotate** and **proofread** your image data. | ||
| quickLinks: | ||
| - title: Community | ||
| content: Meet the team, our mission, and our values | ||
| url: /community/index.html | ||
| metaDescription: napari is a fast multi-dimensional image viewer for Python. It can help you **explore** any image-like data, be it 2D, 3D, or even higher-dimensional. It can also help you **overlay** downstream or **associated data**, such as point coordinates or segmentations, which you can use to **annotate** and **proofread** your image data. | ||
| quickLinks: | ||
| \- title: Community | ||
| content: Meet the team, our mission, and our values | ||
| url: /community/index.html |
There was a problem hiding this comment.
These changes break the rendering:
https://output.circle-artifacts.com/output/job/8682c349-6e0e-4998-b01c-fe613cf134d4/artifacts/0/docs/_build/index.html
Do we need a myst plugin?
There was a problem hiding this comment.
|
@Czaki this came up at the docs meetings Wednesday. This would definitely be a nice thing to get in, but this PR seems like a big lift to get up to speed due to all the conflicts plus fixing the headers that break rendering. My thought was maybe close this and I try to re-implement it with addition of: What do you think? |
|
@psobolewskiPhD It is a good idea |
|
So my playing around with |
|
Looking a bit more deeply, we could switch from colon fence to backticks: But then we lose compatibility with regular markdown... |
Description
add linter and formatted to ensure the best formatting of docs source files.
Type of change
References
How has this been tested?
Final checklist:
trans.to make them localizable.For more information see our translations guide.