Skip to content
Snippets Groups Projects
Commit 2841addf authored by Marek Chrastina's avatar Marek Chrastina
Browse files

Upgrade to mkdocs-material 5.x

parent 20f7ca03
No related branches found
No related tags found
5 merge requests!368Update prace.md to document the change from qprace to qprod as the default...,!367Update prace.md to document the change from qprace to qprod as the default...,!366Update prace.md to document the change from qprace to qprod as the default...,!323extended-acls-storage-section,!278Upgrade to mkdocs-material 5.x
...@@ -57,10 +57,12 @@ ext_links: ...@@ -57,10 +57,12 @@ ext_links:
mkdocs: mkdocs:
stage: build stage: build
image: it4innovations/docker-mkdocscheck:latest image: it4innovations/docker-mkdocscheck:latest
script: before_script:
- python -V # debug - source /opt/.venv3/bin/activate
- python -V # debug
- pip freeze # debug - pip freeze # debug
- mkdocs -V # debug - mkdocs -V # debug
script:
# add version to footer # add version to footer
- bash scripts/add_version.sh - bash scripts/add_version.sh
# get modules list from clusters # get modules list from clusters
...@@ -70,12 +72,8 @@ mkdocs: ...@@ -70,12 +72,8 @@ mkdocs:
# generate ULT for code link # generate ULT for code link
- sed -i "s/master/$CI_BUILD_REF_NAME/g" material/partials/toc.html - sed -i "s/master/$CI_BUILD_REF_NAME/g" material/partials/toc.html
# regenerate modules matrix # regenerate modules matrix
- source /opt/.venv3/bin/activate
- python -V # debug
- pip freeze # debug
- python scripts/modules_matrix.py > docs.it4i/modules-matrix.md - python scripts/modules_matrix.py > docs.it4i/modules-matrix.md
- python scripts/modules_matrix.py --json > docs.it4i/modules-matrix.json - python scripts/modules_matrix.py --json > docs.it4i/modules-matrix.json
- declare -Ff deactivate && deactivate
- curl -f0 https://code.it4i.cz/sccs/scs-api-public/raw/master/scs_api.server_public.md -o docs.it4i/apiv1.md - curl -f0 https://code.it4i.cz/sccs/scs-api-public/raw/master/scs_api.server_public.md -o docs.it4i/apiv1.md
# build pages # build pages
- mkdocs build - mkdocs build
......
.md-icon--edit:before { .md-nav__icon.md-icon svg {
content: "edit"; height: 0.6rem;
} }
.md-icon--check:before { .md-nav__icon.md-icon {
content: "check"; float: left;
} padding-right: .2rem;
.md-icon--help:before {
content: "help";
} }
.md-nav__it4i_link { .md-nav__it4i_link {
...@@ -151,5 +148,4 @@ html .md-nav__it4i_link[for=toc],html .md-nav__it4i_link[for=toc]+.md-nav__it4i_ ...@@ -151,5 +148,4 @@ html .md-nav__it4i_link[for=toc],html .md-nav__it4i_link[for=toc]+.md-nav__it4i_
-webkit-transform: rotateX(180deg); -webkit-transform: rotateX(180deg);
transform: rotateX(180deg) transform: rotateX(180deg)
} }
} }
{% import "partials/language.html" as lang with context %} {% import "partials/language.html" as lang with context %}
<nav class="md-nav md-nav--secondary"> <nav class="md-nav md-nav--secondary" aria-label="{{ lang.t('toc.title') }}">
{% set toc_ = page.toc %} {% set toc_ = page.toc %}
{% if toc_ | first is defined and "\x3ch1 id=" in page.content %} {% if toc_ | first is defined and "\x3ch1 id=" in page.content %}
{% set toc_ = (toc_ | first).children %} {% set toc_ = (toc_ | first).children %}
{% endif %} {% endif %}
{% if page.abs_url == '/' %} {% if page.url == '' %}
{% set it4i_link = config.repo_url + '/edit/master/docs.it4i/index.md' %} {% set it4i_link = config.repo_url + '/edit/master/docs.it4i/index.md' %}
{% set it4i_page = '/index.md' %} {% set it4i_page = '/index.md' %}
{% set it4i_url = 'https://docs.it4i.cz' %} {% set it4i_url = 'https://docs.it4i.cz' %}
...@@ -13,50 +13,40 @@ ...@@ -13,50 +13,40 @@
{% set it4i_page = page.abs_url.rstrip('index.html').rstrip('/') + '.md' %} {% set it4i_page = page.abs_url.rstrip('index.html').rstrip('/') + '.md' %}
{% set it4i_url = 'https://docs.it4i.cz' + page.abs_url %} {% set it4i_url = 'https://docs.it4i.cz' + page.abs_url %}
{% endif %} {% endif %}
<label class="md-nav__title" for="__toc">{{ lang.t("toc.title") }}</label> <label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon">
{% include ".icons/material/arrow-left.svg" %}
</span>
{{ lang.t("toc.title") }}
</label>
<ul class="md-nav__list" data-md-scrollfix> <ul class="md-nav__list" data-md-scrollfix>
{% for toc_item in toc_ %} {% for toc_item in toc_ %}
{% include "partials/toc-item.html" %} {% include "partials/toc-item.html" %}
{% endfor %} {% endfor %}
{% if page.meta.source and page.meta.source | length > 0 %}
<li class="md-nav__item">
<a href="#__source" title="{{ lang.t('meta.source') }}" class="md-nav__link md-nav__link--active">
{{ lang.t("meta.source") }}
</a>
</li>
{% endif %}
{% set disqus = config.extra.disqus %}
{% if page and page.meta and page.meta.disqus is string %}
{% set disqus = page.meta.disqus %}
{% endif %}
{% if not page.is_homepage and disqus %}
<li class="md-nav__item">
<a href="#__comments" title="{{ lang.t('meta.comments') }}" class="md-nav__link md-nav__link--active">
{{ lang.t("meta.comments") }}
</a>
</li>
{% endif %}
</ul> </ul>
<label class="md-nav__title">Actions</label> <label class="md-nav__title">Actions</label>
<ul class="md-nav__list" data-md-scrollfix> <ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="{{ it4i_link }}" title="Edit This Page" class="md-nav__it4i_link" target="_blank"> <a href="{{ it4i_link }}" title="Edit This Page" class="md-nav__it4i_link" target="_blank">
<i class="md-icon md-icon--edit"> <span class="md-nav__icon md-icon">
</i> {% include ".icons/fontawesome/solid/pen.svg" %}
</span>
Edit This Page Edit This Page
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="https://code.it4i.cz/sccs/docs.it4i.cz/issues/new?issue%5Bdescription%5D=Requested change in page [{{ it4i_page }}]({{ it4i_url }}) /cc @hrb33 @kru0052" title="Request Change" class="md-nav__it4i_link" target="_blank"> <a href="https://code.it4i.cz/sccs/docs.it4i.cz/issues/new?issue%5Bdescription%5D=Requested change in page [{{ it4i_page }}]({{ it4i_url }}) /cc @hrb33 @kru0052" title="Request Change" class="md-nav__it4i_link" target="_blank">
<i class="md-icon md-icon--check"> <span class="md-nav__icon md-icon">
</i> {% include ".icons/fontawesome/solid/check.svg" %}
</span>
Request Change Request Change
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="https://support.it4i.cz/rt" title="Get Support" class="md-nav__it4i_link" target="_blank"> <a href="https://support.it4i.cz/rt" title="Get Support" class="md-nav__it4i_link" target="_blank">
<i class="md-icon md-icon--help"> <span class="md-nav__icon md-icon">
</i> {% include ".icons/fontawesome/regular/question-circle.svg" %}
</span>
Get Support Get Support
</a> </a>
</li> </li>
......
...@@ -24,8 +24,13 @@ theme: ...@@ -24,8 +24,13 @@ theme:
static_templates: static_templates:
- 404.html - 404.html
feature: features:
tabs: true - tabs
#- instant
icon:
logo: fontawesome/solid/book-open
repo: fontawesome/brands/gitlab
# Don't include MkDocs' JavaScript # Don't include MkDocs' JavaScript
include_search_page: false include_search_page: false
...@@ -212,17 +217,19 @@ nav: ...@@ -212,17 +217,19 @@ nav:
- PBS Pro Documentation: pbspro.md - PBS Pro Documentation: pbspro.md
extra: extra:
search:
language: 'en'
tokenizer: '[\s\.]+'
repo_icon: gitlab
disqus: 'test-3whnesz3gq' disqus: 'test-3whnesz3gq'
social: social:
- type: 'gitlab' - icon: 'fontawesome/brands/gitlab'
link: 'https://code.it4i.cz/sccs/docs.it4i.cz' link: 'https://code.it4i.cz/sccs/docs.it4i.cz'
- type: globe - icon: fontawesome/solid/globe-europe
link: https://www.it4i.cz link: https://www.it4i.cz
plugins:
- search:
separator: '[\s\.]+'
lang:
- en
markdown_extensions: markdown_extensions:
- codehilite - codehilite
- markdown.extensions.admonition: - markdown.extensions.admonition:
...@@ -232,7 +239,7 @@ markdown_extensions: ...@@ -232,7 +239,7 @@ markdown_extensions:
slugify: !!python/name:pymdownx.slugs.uslugify slugify: !!python/name:pymdownx.slugs.uslugify
- pymdownx.snippets: - pymdownx.snippets:
base_path: snippets base_path: snippets
- pymdownx.superfences - pymdownx.tabbed:
google_analytics: google_analytics:
- 'UA-90498826-1' - 'UA-90498826-1'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment