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

docs: Added material mkdocs tags plugin #5153

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/gis/parser_rest_md.c
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ void usage_rest_md(bool rest)
fprintf(stdout, "description: %s\n", st->module_info.description);
fprintf(stdout, "keywords: ");
G__print_keywords(stdout, NULL, FALSE);
fprintf(stdout, "\n");
fprintf(stdout, "tags: [ ");
G__print_keywords(stdout, NULL, FALSE);
fprintf(stdout, " ]");
fprintf(stdout, "\n---\n\n");

/* main header */
Expand Down
6 changes: 5 additions & 1 deletion man/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ DSTFILES := \
$(MDDIR)/source/grassdocs.css \
$(MDDIR)/scripts/hook_list_scripts.py \
$(MDDIR)/overrides/partials/footer.html \
$(MDDIR)/overrides/partials/actions.html
$(MDDIR)/overrides/partials/actions.html \
$(MDDIR)/source/tags.md

categories = \
d:display \
Expand Down Expand Up @@ -258,6 +259,9 @@ $(MDDIR)/source/favicon.ico: favicon.ico
$(MDDIR)/source/grassdocs.css: mkdocs/grassdocs.css
$(INSTALL_DATA) $< $@

$(MDDIR)/source/tags.md: mkdocs/tags.md
$(INSTALL_DATA) $< $@

$(MDDIR)/scripts/hook_list_scripts.py: mkdocs/scripts/hook_list_scripts.py | $(MDDIR)/scripts
$(INSTALL_DATA) $< $@

Expand Down
3 changes: 1 addition & 2 deletions man/mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,10 @@ extra_css:
plugins:
- search
- glightbox
- tags
- social:
cards_layout_options:
background_image: null

# - tags
# - git-revision-date-localized:
# enable_creation_date: true
# - git-committers:
Expand Down
4 changes: 2 additions & 2 deletions man/mkdocs/overrides/partials/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@

<!-- Further information -->
<div class="md-footer-meta md-typeset">
<center>
<a href="./index.html">Main index</a> | <a href="./topics.html">Topics index</a> | <a href="./keywords.html">Keywords index</a> | <a href="./graphical_index.html">Graphical index</a> | <a href="./full_index.html">Full index</a><br>
<center>
<a href="./index.html">Main index</a> | <a href="./topics.html">Topics index</a> | <a href="./keywords.html">Keywords index</a> | <a href="./tags.html">Tags index</a> | <a href="./graphical_index.html">Graphical index</a> | <a href="./full_index.html">Full index</a><br>
</center>
<div class="md-footer-meta__inner md-grid">
{% include "partials/copyright.html" %}
Expand Down
5 changes: 5 additions & 0 deletions man/mkdocs/tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Tags

Following is a list of relevant tags:

<!-- material/tags -->
Loading