-
-
Notifications
You must be signed in to change notification settings - Fork 339
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
docs: Added material mkdocs tags plugin #5153
base: main
Are you sure you want to change the base?
Conversation
While just using the tags instead of a currently working custom keywords system is not a priority, and some pieces will need to me preserved for keeping functioning URLs (if someone links https://grass.osgeo.org/grass-stable/manuals/keywords.html), this may help solving keywords for addons which currently work for HTML, but not for Markdown. However, given this needs the addon situation to be resolved, let's wait with this a bit to see how #5152 develops. Example with a addon-only keyword is v.vect.stats.multi.md with keyword 'columns'. |
This is an easy fix. We just need to leave the keyword tag in the header for now.
I'll need to see this because I'm not following.
I agree this can wait until we resolve the addons. |
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.
I like it, but I meant to request changes for the footer.
The Tags index in the footer doesn't work, links to ./addons/tags.html, but that's the same for keywords. |
Addresses Issue #5091
This pull request includes multiple changes to improve the documentation and tagging system in the project.
Modified md keyword generation in documentation:
lib/gis/parser_rest_md.c
: Changed the keyword output to use "tags" instead, and adjusted the format to include brackets.lib/gis/parser_rest_md.c
: Removed the conditional keyword section to streamline the output format.Updates to build process and documentation files:
man/Makefile
: Addedtags.md
to the list of documentation source files and ensured it gets installed correctly. [1] [2]man/mkdocs/mkdocs.yml
: Enabled thetags
plugin in the MkDocs configuration to support tag-based navigation.man/mkdocs/overrides/partials/footer.html
: Updated the footer to include a link to the new Tags index.man/mkdocs/tags.md
: Added a new file to list relevant tags for the documentation.