MkDocs theme build to layout the documentation of the Bioiformatic Unit, Istituto Zooprofilattico dell' Abruzzo e del Molise
Project description
mkdocs-bioinformatic-izsam-theme
This is an MkDocs theme written to layout the documentation provided by Bioinformatic Unit of the Istituto Zooprofilattico Sperimentale dell'Abruzzo e del Molise "G. Caporale".
Important!
The theme is intended to work with the following mkdocs-izsam-search a plugin to extend search functions https://pypi.org/project/mkdocs-izsam-search/
pip install mkdocs-izsam-search
Theme customization
The theme allows you to customize Title and top right label using your mdkdocs configuration file mkdocs.yml
.
extra:
platform_title: Piattaforma GenPat
header_tool_label: Wiki
header_tool_label_mobile: Wiki
Theme localization
The theme supports a lightweight localization system written in vanilla javascript. At the moment it supports Italian and English but you are free to add every language by duplicate the existing js/theme-langauges/theme-loc-en.js
file and renaming it with your language a for example js/theme-langauges/theme-loc-it.js
, and then edit js/theme-localization.js
if needed.
Please refer to MkDocs documentation on how to customize a theme https://www.mkdocs.org/user-guide/customizing-your-theme/#customizing-your-theme.
To activate the localization, add a value to locale
in config.theme
:
theme:
name: bioinformatic-izsam-theme
locale: it
Here the code used in the theme to hold the localization:
{% if config.theme.locale %}
{% set js_path = 'js/theme-languages/theme-loc-' ~ config.theme.locale ~ '.js' %}
<script src="{{ js_path|url }}"></script>
<script src="{{ 'js/theme-localization.js'|url }}"></script>
{% endif %}
Important!
The locale
variable is used also to set search functionalities, there are some limitations on the value it can assume. Allowed languages are: ar
, da
, de
, du
, es
, fi
, fr
, hi
, hu
, it
, ja
, jp
, nl
, no
, pt
, ro
, ru
, sv
, ta
, th
, tr
, vi
, zh
. If you want to use a different language, you should not to use mkdocs-izsam-search plugin and customize the base.html
file removing all the code related to it.
Change log
[0.0.6] - 2021-11-15
Theme localization, integration of a footer.css, ui emprovement.
- Added theme localization for search.html file.
- Added theme localization for 404.html file.
- Added a footer.css file.
- Small changes in the main theme.css style for left menu.
[0.0.5] - 2021-11-12
Theme localization
- The theme now support it and en localization and it can be extended with other langauges.
[0.0.4] - 2021-11-12
Added support for other languages besides en
to make theme working with mkdocs-izsam-search plugin
- The theme now support languages present in
js/lunr-languages
and can be defined intheme.locale
of the.yml
configuration file. Multilanguage is not supported yet.
[0.0.2] and [0.0.3] - 2021-11-11
Debug on setup
- Fixed bugs for the mkdocs entry point in
setup.py
[0.0.1] - 2021-11-11
First release
- Made stuff necessary to package a theme
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-bionformatic-izsam-theme-0.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fce81abb533bed0c97f653721defcacf6e2b826317ecb003aa5e98f8652a3cd |
|
MD5 | e34ab61e579a6709cfcc483c7308c502 |
|
BLAKE2b-256 | 91a8a487239935b0ce7c42a529f1bfbdf6a0b6c06de59076c51e6f9dc2faead0 |
Hashes for mkdocs_bionformatic_izsam_theme-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93dcfaaaf5eab18b82e479ac26ca8d364131e1aeb57febc223708c1d9c97fded |
|
MD5 | c59f095620f631dcf4a3b65fcbe283cd |
|
BLAKE2b-256 | e270701642c232daecb3f9923e2f8910da5fbf9c4a25f965a4e99ee0c462f6ec |