Package: mkdocs-bionformatic-izsam-theme
mkdocs-bioinformatic-izsam-themeThis 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 pluginmkdocs-izsam-searchhttps://pypi.org/project/mkdocs-izsam-search/pipinstallmkdocs-izsam-searchTheme customizationThe theme allows you to customize Title and top right label using your mdkdocs configuration filemkdocs.yml.extra:platform_title:Piattaforma GenPatheader_tool_label:Wikiheader_tool_label_mobile:WikiTheme localizationThe 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 existingjs/theme-langauges/theme-loc-en.jsfile and renaming it with your language a for examplejs/theme-langauges/theme-loc-it.js. Edit/overridejs/theme-localization.jsto add more fields and translations.Please refer to MkDocs documentation on how to customize a themehttps://www.mkdocs.org/user-guide/customizing-your-theme/#customizing-your-theme.To activate the localization, add a value tolocaleinconfig.theme:theme:
  name: bioinformatic-izsam-theme
  locale: itHere 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' %}<scriptsrc="{{ js_path|url }}"></script><scriptsrc="{{ 'js/theme-localization.js'|url }}"></script>{% endif %}Important!Thelocalevariable 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 usemkdocs-izsam-searchplugin and customize thebase.htmlfile removing all the code related to it.Theme featuresUse image captionIf you need to use a caption for images, you can use the markdown image title sintax.![](image.png "image title")A function intheme.jsloops all images and if a title exists will append afigcaptiontag after the image.Use icons inlineTo use icons inline inside the contents, please add the alt attributeinline-icon:![inline-icon](icona.png)Images will have inherent size and displayed inline.Use diagram as images (no plantuml)To use diagram inside the contents as images, please add the alt attributediagramto avoid box shadow.![diagram](file.png)Expand imagezoom-img.jsallows images to be expanded on click.Change log[0.2.2] - 2023-12-1Small fix related to 0.2 releasEdited base.html[0.2.1] - 2023-08-29Small fix related to 0.2 releasEdited base.html[0.2] - 2023-08-29Refactoring and bug fix for searchChange in multilingual handling for search in order to resolve issues related to searching for words containing the underscore character (_).Edited base.htmlEdited js/search.js[0.1.9.3] - 2023-05-15Ux improvement for main menu in mobile viewEdited theme.cssEdited base.html[0.1.9.2] - 2023-03-28Bug fix for ordered listEdited theme.css[0.1.9.1] - 2022-12-09Ux improvement for main menu in mobile viewEdited theme.css[0.1.9] - 2022-10-24Small fix on Ux improvement for main menu in mobile viewEdited theme.css and base.html[0.1.8] - 2022-10-24Ux improvement for main menu in mobile viewEdited theme.css and base.html[0.1.7] - 2022-05-12Debug and refactoring for theme.jsEdited theme.js[0.1.6] - 2022-05-12Fix for image caption functionEdited theme.css and theme.js[0.1.5] - 2022-05-12Added support for image captionEdited theme.css and theme.jsReadme improvementsEdited README.md[0.1.4] - 2022-05-2CSS: added rule for html video tagEdited theme.css[0.1.3] - 2022-04-27Html base template: changed next and previous buttons in order to integrate parent titleEdited base.html[0.1.2] - 2022-03-18Layout improvement.Edited theme.css[0.1.1] - 2022-01-25Layout improvement.Edited theme.css[0.1.0] - 2022-01-25Layout improvement.Edited theme.css[0.0.9] - 2022-01-25Layout changes: form fields and buttons aspect.Edited theme.css[0.0.8] - 2021-11-24Layout improvement.Edited theme.css[0.0.7] - 2021-11-15Project description.Edited README.md[0.0.6] - 2021-11-15Theme 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-12Theme localizationThe theme now support it and en localization and it can be extended with other langauges.[0.0.4] - 2021-11-12Added support for other languages besidesento make theme working with mkdocs-izsam-search pluginThe theme now support languages present injs/lunr-languagesand can be defined intheme.localeof the.ymlconfiguration file. Multilanguage is not supported yet.[0.0.2] and [0.0.3] - 2021-11-11Debug on setupFixed bugs for the mkdocs entry point insetup.py[0.0.1] - 2021-11-11First releaseMade stuff necessary to package a theme