diff --git a/.gitea/workflows/deploy.yml b/.gitea/workflows/deploy.yml index f99a2ec..b19881b 100644 --- a/.gitea/workflows/deploy.yml +++ b/.gitea/workflows/deploy.yml @@ -26,6 +26,7 @@ jobs: mkdocs-material[git]=="9.7.*" \ mkdocs-material[imaging]=="9.7.*" \ mkdocs-glightbox=='0.5.*' \ - mkdocs-include-markdown-plugin=='7.2.*' + mkdocs-include-markdown-plugin=='7.2.*' \ + mkdocs-llmstxt=='0.5.*' - name: Deploy documentation run: mkdocs gh-deploy --force -b gitea-pages diff --git a/Dockerfile b/Dockerfile index d41313f..73a59a8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,7 @@ FROM docker.io/squidfunk/mkdocs-material:9.7 # add some plugins -RUN pip install mkdocs-glightbox=='0.5.*' -RUN pip install mkdocs-include-markdown-plugin=='7.2.*' +RUN pip install \ + mkdocs-glightbox=='0.5.*' \ + mkdocs-include-markdown-plugin=='7.2.*' \ + mkdocs-llmstxt=='0.5.*' diff --git a/mkdocs.yml b/mkdocs.yml index 567cff1..4c05bb0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -56,6 +56,16 @@ plugins: blog_dir: news - glightbox - include-markdown + - llmstxt: + markdown_description: HPCE User documentation for the Merlin Clusters + sections: + Cluster Docs: + - 'merlin*/*.md' + - 'meg*/*.md' + CSCS Userlab Docs: + - 'cscs*/*.md' + Support: + - 'support/*.md' # Extensions markdown_extensions: @@ -63,6 +73,7 @@ markdown_extensions: - attr_list - footnotes - md_in_html + - meta - tables - toc: permalink: true diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..1f8bca1 --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,14 @@ +{% extends "base.html" %} + +{% block extrahead %} + {% set title = config.site_name %} + {% if page and page.meta and page.meta.title %} + {% set title = title ~ " - " ~ page.meta.title %} + {% elif page and page.title and not page.is_homepage %} + {% set title = title ~ " - " ~ page.title | striptags %} + {% endif %} + + + + +{% endblock %}