# 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/](https://pypi.org/project/mkdocs-izsam-search/)
```bash
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`.
```yaml
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](https://www.mkdocs.org/user-guide/customizing-your-theme/#customizing-your-theme).
To activate the localization, add a value to `locale` in `config.theme`:
```yml
theme:
name: bioinformatic-izsam-theme
locale: it
```
Here the code used in the theme (`base.html`) to hold the localization:
```html
{% 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.
## Theme features
#### Use image caption
If you need to use a caption for images, you can use the markdown image title sintax.
``
> A function in `theme.js` loops all images and if a title exists will append a `figcaption` tag after the image.
#### Use icons inline
To use icons inline inside the contents, please add the alt attribute `inline-icon`:
```
```
> 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 attribute `diagram` to avoid box shadow.
```
```
#### Expand image
`zoom-img.js` allows images to be expanded on click.
# Change log
## [0.2.2] - 2023-12-1
### Small fix related to 0.2 releas
- Edited base.html
## [0.2.1] - 2023-08-29
### Small fix related to 0.2 releas
- Edited base.html
## [0.2] - 2023-08-29
### Refactoring and bug fix for search
Change in multilingual handling for search in order to resolve issues related to searching for words containing the underscore character (`_`).
- Edited base.html
- Edited js/search.js
## [0.1.9.3] - 2023-05-15
### Ux improvement for main menu in mobile view
- Edited theme.css
- Edited base.html
## [0.1.9.2] - 2023-03-28
### Bug fix for ordered list
- Edited theme.css
## [0.1.9.1] - 2022-12-09
### Ux improvement for main menu in mobile view
- Edited theme.css
## [0.1.9] - 2022-10-24
### Small fix on Ux improvement for main menu in mobile view
- Edited theme.css and base.html
## [0.1.8] - 2022-10-24
### Ux improvement for main menu in mobile view
- Edited theme.css and base.html
## [0.1.7] - 2022-05-12
### Debug and refactoring for theme.js
- Edited theme.js
## [0.1.6] - 2022-05-12
### Fix for image caption function
- Edited theme.css and theme.js
## [0.1.5] - 2022-05-12
### Added support for image caption
- Edited theme.css and theme.js
### Readme improvements
- Edited README.md
## [0.1.4] - 2022-05-2
### CSS: added rule for html video tag
- Edited theme.css
## [0.1.3] - 2022-04-27
### Html base template: changed next and previous buttons in order to integrate parent title
- Edited base.html
## [0.1.2] - 2022-03-18
### Layout improvement.
- Edited theme.css
## [0.1.1] - 2022-01-25
### Layout improvement.
- Edited theme.css
## [0.1.0] - 2022-01-25
### Layout improvement.
- Edited theme.css
## [0.0.9] - 2022-01-25
### Layout changes: form fields and buttons aspect.
- Edited theme.css
## [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 in `theme.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
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-bionformatic-izsam-theme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "MkDocs,Theme,Software documentation",
"author": "Alessandro De Luca",
"author_email": "al.deluca@izs.it",
"download_url": "https://files.pythonhosted.org/packages/03/f8/6a716dcd1c0af3d5061d651b7bcb250b24339b1ea7ea84a3d4db5729043c/mkdocs-bionformatic-izsam-theme-0.2.2.tar.gz",
"platform": null,
"description": "# mkdocs-bioinformatic-izsam-theme\n\nThis 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\".\n\n#### Important!\n\nThe theme is intended to work with the plugin **mkdocs-izsam-search** [https://pypi.org/project/mkdocs-izsam-search/](https://pypi.org/project/mkdocs-izsam-search/)\n\n```bash\npip install mkdocs-izsam-search\n```\n\n## Theme customization\n\nThe theme allows you to customize Title and top right label using your mdkdocs configuration file `mkdocs.yml`.\n\n```yaml\nextra:\n platform_title: Piattaforma GenPat\n header_tool_label: Wiki\n header_tool_label_mobile: Wiki\n```\n\n## Theme localization\n\nThe 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.\n\n> Please refer to MkDocs documentation on how to customize a theme [https://www.mkdocs.org/user-guide/customizing-your-theme/#customizing-your-theme](https://www.mkdocs.org/user-guide/customizing-your-theme/#customizing-your-theme).\n\nTo activate the localization, add a value to `locale` in `config.theme`:\n\n```yml\ntheme:\n name: bioinformatic-izsam-theme\n locale: it\n```\n\nHere the code used in the theme (`base.html`) to hold the localization:\n\n```html\n{% if config.theme.locale %}\n {% set js_path = 'js/theme-languages/theme-loc-' ~ config.theme.locale ~ '.js' %}\n <script src=\"{{ js_path|url }}\"></script>\n <script src=\"{{ 'js/theme-localization.js'|url }}\"></script>\n{% endif %}\n```\n\n#### Important!\n\nThe `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.\n\n## Theme features\n\n#### Use image caption\n\nIf you need to use a caption for images, you can use the markdown image title sintax.\n\n`![](image.png \"image title\")`\n\n> A function in `theme.js` loops all images and if a title exists will append a `figcaption` tag after the image.\n\n#### Use icons inline\n\nTo use icons inline inside the contents, please add the alt attribute `inline-icon`:\n\n```\n\n```\n\n> Images will have inherent size and displayed inline.\n\n#### Use diagram as images (no plantuml)\n\nTo use diagram inside the contents as images, please add the alt attribute `diagram` to avoid box shadow.\n\n```\n\n```\n\n#### Expand image\n\n`zoom-img.js` allows images to be expanded on click.\n\n# Change log\n\n## [0.2.2] - 2023-12-1\n\n### Small fix related to 0.2 releas\n- Edited base.html\n\n## [0.2.1] - 2023-08-29\n\n### Small fix related to 0.2 releas\n- Edited base.html\n\n## [0.2] - 2023-08-29\n\n### Refactoring and bug fix for search\nChange in multilingual handling for search in order to resolve issues related to searching for words containing the underscore character (`_`).\n- Edited base.html\n- Edited js/search.js\n\n## [0.1.9.3] - 2023-05-15\n\n### Ux improvement for main menu in mobile view\n- Edited theme.css\n- Edited base.html\n\n## [0.1.9.2] - 2023-03-28\n\n### Bug fix for ordered list\n- Edited theme.css\n\n## [0.1.9.1] - 2022-12-09\n\n### Ux improvement for main menu in mobile view\n- Edited theme.css\n\n## [0.1.9] - 2022-10-24\n\n### Small fix on Ux improvement for main menu in mobile view\n- Edited theme.css and base.html\n\n## [0.1.8] - 2022-10-24\n\n### Ux improvement for main menu in mobile view\n- Edited theme.css and base.html\n\n## [0.1.7] - 2022-05-12\n\n### Debug and refactoring for theme.js\n- Edited theme.js\n\n## [0.1.6] - 2022-05-12\n\n### Fix for image caption function\n- Edited theme.css and theme.js\n\n## [0.1.5] - 2022-05-12\n\n### Added support for image caption\n- Edited theme.css and theme.js\n\n### Readme improvements\n- Edited README.md\n\n## [0.1.4] - 2022-05-2\n\n### CSS: added rule for html video tag\n- Edited theme.css\n\n## [0.1.3] - 2022-04-27\n\n### Html base template: changed next and previous buttons in order to integrate parent title\n- Edited base.html\n\n## [0.1.2] - 2022-03-18\n\n### Layout improvement.\n- Edited theme.css\n\n## [0.1.1] - 2022-01-25\n\n### Layout improvement.\n- Edited theme.css\n\n## [0.1.0] - 2022-01-25\n\n### Layout improvement.\n- Edited theme.css\n\n## [0.0.9] - 2022-01-25\n\n### Layout changes: form fields and buttons aspect.\n- Edited theme.css\n\n## [0.0.8] - 2021-11-24\n\n### Layout improvement.\n- Edited theme.css\n\n## [0.0.7] - 2021-11-15\n\n### Project description.\n- Edited README.md\n\n## [0.0.6] - 2021-11-15\n\n### Theme localization, integration of a footer.css, ui emprovement.\n- Added theme localization for search.html file.\n- Added theme localization for 404.html file.\n- Added a footer.css file.\n- Small changes in the main theme.css style for left menu.\n\n## [0.0.5] - 2021-11-12\n\n### Theme localization\n- The theme now support it and en localization and it can be extended with other langauges.\n\n## [0.0.4] - 2021-11-12\n\n### Added support for other languages besides `en` to make theme working with mkdocs-izsam-search plugin\n- The theme now support languages present in `js/lunr-languages` and can be defined in `theme.locale` of the `.yml` configuration file. Multilanguage is not supported yet.\n\n## [0.0.2] and [0.0.3] - 2021-11-11\n\n### Debug on setup\n- Fixed bugs for the mkdocs entry point in `setup.py` \n\n## [0.0.1] - 2021-11-11\n\n### First release\n- Made stuff necessary to package a theme\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs theme designed for Bioiformatic Unit of the Istituto Zooprofilattico dell' Abruzzo e del Molise G. Caporale",
"version": "0.2.2",
"project_urls": null,
"split_keywords": [
"mkdocs",
"theme",
"software documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b85f9217063a6eb78ddb3433a483a12f028de19808f81af03d25b2a81f30375",
"md5": "ae386d09253dc29cd28bdd4933329ad0",
"sha256": "ebc2b7ae3d5aa8d97c04c12f72ff37afa67aadcae3b9dd0ca55bac67308e7e85"
},
"downloads": -1,
"filename": "mkdocs_bionformatic_izsam_theme-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae386d09253dc29cd28bdd4933329ad0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 735825,
"upload_time": "2023-12-01T13:07:32",
"upload_time_iso_8601": "2023-12-01T13:07:32.794754Z",
"url": "https://files.pythonhosted.org/packages/1b/85/f9217063a6eb78ddb3433a483a12f028de19808f81af03d25b2a81f30375/mkdocs_bionformatic_izsam_theme-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03f86a716dcd1c0af3d5061d651b7bcb250b24339b1ea7ea84a3d4db5729043c",
"md5": "5eb35944115648407f584bc0d9ba3abb",
"sha256": "306cb1915ab9c20f66f3eb04ac49fee8d966bec59769b6693496e406c49663cd"
},
"downloads": -1,
"filename": "mkdocs-bionformatic-izsam-theme-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "5eb35944115648407f584bc0d9ba3abb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 684807,
"upload_time": "2023-12-01T13:07:35",
"upload_time_iso_8601": "2023-12-01T13:07:35.552663Z",
"url": "https://files.pythonhosted.org/packages/03/f8/6a716dcd1c0af3d5061d651b7bcb250b24339b1ea7ea84a3d4db5729043c/mkdocs-bionformatic-izsam-theme-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 13:07:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkdocs-bionformatic-izsam-theme"
}
JSON