From 2841addf88fdf98bfdf3845285201069711b1881 Mon Sep 17 00:00:00 2001
From: Marek Chrastina <marek.chrastina@vsb.cz>
Date: Wed, 29 Apr 2020 09:22:04 +0200
Subject: [PATCH] Upgrade to mkdocs-material 5.x
---
.gitlab-ci.yml | 10 ++++-----
docs.it4i/src/css.css | 14 +++++-------
material/partials/toc.html | 44 +++++++++++++++-----------------------
mkdocs.yml | 25 ++++++++++++++--------
4 files changed, 42 insertions(+), 51 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index d72ee28f9..5c3fb1634 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -57,10 +57,12 @@ ext_links:
mkdocs:
stage: build
image: it4innovations/docker-mkdocscheck:latest
- script:
- - python -V # debug
+ before_script:
+ - source /opt/.venv3/bin/activate
+ - python -V # debug
- pip freeze # debug
- mkdocs -V # debug
+ script:
# add version to footer
- bash scripts/add_version.sh
# get modules list from clusters
@@ -70,12 +72,8 @@ mkdocs:
# generate ULT for code link
- sed -i "s/master/$CI_BUILD_REF_NAME/g" material/partials/toc.html
# 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 --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
# build pages
- mkdocs build
diff --git a/docs.it4i/src/css.css b/docs.it4i/src/css.css
index a36fde9ef..fc0060f57 100644
--- a/docs.it4i/src/css.css
+++ b/docs.it4i/src/css.css
@@ -1,13 +1,10 @@
-.md-icon--edit:before {
- content: "edit";
+.md-nav__icon.md-icon svg {
+ height: 0.6rem;
}
-.md-icon--check:before {
- content: "check";
-}
-
-.md-icon--help:before {
- content: "help";
+.md-nav__icon.md-icon {
+ float: left;
+ padding-right: .2rem;
}
.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_
-webkit-transform: rotateX(180deg);
transform: rotateX(180deg)
}
-
}
diff --git a/material/partials/toc.html b/material/partials/toc.html
index bd79493ff..847caf00e 100644
--- a/material/partials/toc.html
+++ b/material/partials/toc.html
@@ -1,10 +1,10 @@
{% 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 %}
{% if toc_ | first is defined and "\x3ch1 id=" in page.content %}
{% set toc_ = (toc_ | first).children %}
{% endif %}
- {% if page.abs_url == '/' %}
+ {% if page.url == '' %}
{% set it4i_link = config.repo_url + '/edit/master/docs.it4i/index.md' %}
{% set it4i_page = '/index.md' %}
{% set it4i_url = 'https://docs.it4i.cz' %}
@@ -13,50 +13,40 @@
{% set it4i_page = page.abs_url.rstrip('index.html').rstrip('/') + '.md' %}
{% set it4i_url = 'https://docs.it4i.cz' + page.abs_url %}
{% 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>
{% for toc_item in toc_ %}
{% include "partials/toc-item.html" %}
{% 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>
<label class="md-nav__title">Actions</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="{{ it4i_link }}" title="Edit This Page" class="md-nav__it4i_link" target="_blank">
- <i class="md-icon md-icon--edit">
- </i>
+ <span class="md-nav__icon md-icon">
+ {% include ".icons/fontawesome/solid/pen.svg" %}
+ </span>
Edit This Page
</a>
</li>
<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">
- <i class="md-icon md-icon--check">
- </i>
+ <span class="md-nav__icon md-icon">
+ {% include ".icons/fontawesome/solid/check.svg" %}
+ </span>
Request Change
</a>
</li>
<li class="md-nav__item">
<a href="https://support.it4i.cz/rt" title="Get Support" class="md-nav__it4i_link" target="_blank">
- <i class="md-icon md-icon--help">
- </i>
+ <span class="md-nav__icon md-icon">
+ {% include ".icons/fontawesome/regular/question-circle.svg" %}
+ </span>
Get Support
</a>
</li>
diff --git a/mkdocs.yml b/mkdocs.yml
index b740e0b3d..524d5662e 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -24,8 +24,13 @@ theme:
static_templates:
- 404.html
- feature:
- tabs: true
+ features:
+ - tabs
+ #- instant
+
+ icon:
+ logo: fontawesome/solid/book-open
+ repo: fontawesome/brands/gitlab
# Don't include MkDocs' JavaScript
include_search_page: false
@@ -212,17 +217,19 @@ nav:
- PBS Pro Documentation: pbspro.md
extra:
- search:
- language: 'en'
- tokenizer: '[\s\.]+'
- repo_icon: gitlab
disqus: 'test-3whnesz3gq'
social:
- - type: 'gitlab'
+ - icon: 'fontawesome/brands/gitlab'
link: 'https://code.it4i.cz/sccs/docs.it4i.cz'
- - type: globe
+ - icon: fontawesome/solid/globe-europe
link: https://www.it4i.cz
+plugins:
+ - search:
+ separator: '[\s\.]+'
+ lang:
+ - en
+
markdown_extensions:
- codehilite
- markdown.extensions.admonition:
@@ -232,7 +239,7 @@ markdown_extensions:
slugify: !!python/name:pymdownx.slugs.uslugify
- pymdownx.snippets:
base_path: snippets
- - pymdownx.superfences
+ - pymdownx.tabbed:
google_analytics:
- 'UA-90498826-1'
--
GitLab