I thought there was one, but I can’t find a document detailing all the requirements for the manual page in MD format (like only having 0 or 2 trailing white spaces, how to format functions, parameters, etc.).
Additional questions, is it still required to keep the lines limited to 80 characters? And when updating an (addon’s) manual page, do we need to keep the HTML, or can that be removed?
The rules are stated in https://github.com/OSGeo/grass/blob/main/.markdownlint.yml, which is with few exceptions the default of https://github.com/igorshubovych/markdownlint-cli (and in extension https://github.com/DavidAnson/markdownlint).
The rule regarding line length is described at https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
The idea is that, using the linter directly or via pre-commit, you don’t really have to keep track of these rules. You’ll be notified if something is “wrong”.
I’m not up-to-date on the question on HTML vs. MD.
On 5 Apr 2025, at 11:31, Paulo van Breugel via OSGeo Discourse noreply@discourse.osgeo.org wrote:
ecodiv
April 5I thought there was one, but I can’t find a document detailing all the requirements for the manual page in MD format (like only having 0 or 2 trailing white spaces, how to format functions, parameters, etc.).
Additional questions, is it still required to keep the lines limited to 80 characters? And when updating an (addon’s) manual page, do we need to keep the HTML, or can that be removed?
Visit Topic or reply to this email to respond.
To unsubscribe from these emails, click here.
Thanks. I installed markdownlint for VS Code, which does indeed help one to identify issues.
For grass-addons, I think html is still needed for a while, markdown docs is not even shipped in a release yet. So the latest 8.4 still needs it. Unless there is no issues when an addon doesn’t have docs, except the inconvenience of not having the docs in the interface.
