MkDocs theme designed for Bioiformatic Unit of the Istituto Zooprofilattico dell' Abruzzo e del Molise G. Caporale
Project description
mkdocs-bioinformatic-izsam-theme
This is an MkDocs theme designed 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 plugin mkdocs-izsam-search 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 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
. Edit/override js/theme-localization.js
to add more fields and translations.
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 (base.html
) 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 values 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.8] - 2021-11-24
Layout improvement.
- Edited theme.css
[0.0.7] - 2021-11-15
Project description.
- Edited README.md
[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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0194a31e6ac8e8d04ca8a4791f3bcfa693266024cff1c5c5945c856f43f7b5f4 |
|
MD5 | 2b1a98ca8aeae38661448449336202e9 |
|
BLAKE2b-256 | 8517e2cd995538d9f490b3bed299cffd5503223ea223306589bdf01f2656f0c1 |
Hashes for mkdocs_bionformatic_izsam_theme-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fc84ca680e7ba4f5f9b52d98772c974d939449494675d51d09dd8bb6639010b |
|
MD5 | 053c423c47c258b46bf198bf68668813 |
|
BLAKE2b-256 | 854fbcd5e81241f630a960153b791f927e94c8aa8e45f8d10aa297eb48389878 |