{"id":16314403,"url":"https://github.com/unverbuggt/mkdocs-risonia-theme","last_synced_at":"2025-10-25T17:30:18.792Z","repository":{"id":64837542,"uuid":"532211272","full_name":"unverbuggt/mkdocs-risonia-theme","owner":"unverbuggt","description":"A simple theme for MkDocs, using the w3.css framework and configurable color schemes.","archived":false,"fork":false,"pushed_at":"2023-09-08T07:46:49.000Z","size":1783,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-31T09:22:16.148Z","etag":null,"topics":["dark-theme","mkdocs","template","theme","w3css"],"latest_commit_sha":null,"homepage":"https://unverbuggt.github.io/mkdocs-risonia-theme/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unverbuggt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-03T09:16:17.000Z","updated_at":"2024-08-13T12:23:43.000Z","dependencies_parsed_at":"2023-02-12T09:01:42.106Z","dependency_job_id":null,"html_url":"https://github.com/unverbuggt/mkdocs-risonia-theme","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unverbuggt%2Fmkdocs-risonia-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unverbuggt%2Fmkdocs-risonia-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unverbuggt%2Fmkdocs-risonia-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unverbuggt%2Fmkdocs-risonia-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unverbuggt","download_url":"https://codeload.github.com/unverbuggt/mkdocs-risonia-theme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238183478,"owners_count":19430125,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dark-theme","mkdocs","template","theme","w3css"],"created_at":"2024-10-10T21:53:52.847Z","updated_at":"2025-10-25T17:30:17.978Z","avatar_url":"https://github.com/unverbuggt.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-risonia-theme\n\n[![PyPI Version](https://img.shields.io/pypi/v/mkdocs-risonia-theme.svg)](https://pypi.org/project/mkdocs-risonia-theme/)\n[![PyPI downloads](https://img.shields.io/pypi/dm/mkdocs-risonia-theme.svg)](https://pypi.org/project/mkdocs-risonia-theme)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) \n\nA simple theme for [MkDocs](https://www.mkdocs.org/). Based on [this demo](https://www.w3schools.com/w3css/tryw3css_examples_material.htm) \nusing the [w3.css](https://www.w3schools.com/w3css/) framework and configurable color schemes\n(inspiration [here](https://www.w3schools.com/colors/colors_schemes.asp)).\n\n## Demo\n\nSee a demo and documentation [here](https://unverbuggt.xn--rthlein-n2a.de/risonia/en/)\n\n![](https://github.com/unverbuggt/mkdocs-risonia-theme/raw/main/screen_big.png)\n![](https://github.com/unverbuggt/mkdocs-risonia-theme/raw/main/screen_small.png)\n\n## Design goals\n\n* Be a simple starting point for modifications.\n* Be colorful and readable.\n* Implement all features of the standard MkDocs theme (in progress).\n* Integrate some useful plugins.\n* Don't require translations.\n* Don't be obfuscated.\n* Add as little nonsense as possible.\n\n## Ugly compromises\n\n* To use w3css we need to add additional classes to the markdown output.\n    * The good part is, while we're at it, we are also able to mark externals links.\n* The SVG icons need to be included in every page, because otherwise they can't be set to the text color.\n\n## Features\n\n* Light and dark mode.\n* Integration of `mkdocs-static-i18n` plugin.\n* Integration of `mkdocs-encryptcontent-plugin`.\n* Web app support.\n* Rather [lightweight](https://unverbuggt.xn--rthlein-n2a.de/risonia/en/mkdocs/#size-comparison)\n* Short (nav) and long (top panel) [page titles](#page-titles)\n\n## Installation\n\nInstall the package with pip:\n\n```bash\npip install mkdocs-risonia-theme\n```\n\nInstall the package from source with pip:\n\n```bash\ncd mkdocs-risonia-theme/\npython setup.py sdist bdist_wheel\npip install dist/mkdocs_risonia_theme-0.1.12-py3-none-any.whl\n```\n\n## Configuration\n\nEnable the theme and plugins in your `mkdocs.yml`:\n\n```yaml\ntheme:\n    name: risonia\n    #custom_dir: theme_override/ # add static files or overrides\n    #logo: img/logo.svg # if undefined a burger symbol is displayed on mobile devices\n    #favicon: img/logo.ico # if undefined img/favicon.ico is used\n    #manifest: manifest.json # manifest for installable webapp\n    #serviceworker: service-worker.js # for webapp an empty file is sufficient\n    #extlink: true # mark external links with symbol\n    #extblank: true # send external links to new browser tab\n    #toc_sidebar: true # If display is wide enough, then display TOC on the right side\n    #zoom_img: true # click on images to view them bigger\n    \nplugins:\n    - search: {}\n\n    #- i18n: {...} # mkdocs-static-i18n\n\n    - color-theme: # optional\n        theme_color: '#ff6600' # primary color\n        secondary_color: 'complementary' # can be a color or scheme\n        light_text_color: '#000' # black\n        dark_text_color: '#fff' # white\n        extra_css_light: # list of extra CSS for light mode\n            - 'css/additional-light.css'\n        extra_css_dark:  # list of extra CSS for dark mode\n            - 'css/additional-dark.css'\n        additional: # build these themes also\n          - theme_color: '#44bb4f'\n            secondary_color: 'complementary'\n\n    - w3css-classes: {} # mandatory\n\n    #- encryptcontent: {...} # mkdocs-encryptcontent-plugin\n```\n\n## Overrides\n\nThe file `main.html` in `custom_dir` can be used to further customize the template:\n\n```html\n{% extends \"base.html\" %}\n\n{% block exec_script %}\n\u003cscript\u003e\n  var DOMContentLoaded_fired = false;\n\u003c/script\u003e\n\u003cscript id=\"theme\"\u003e\nfunction runWhenDOMContentLoaded() {\n  document.querySelectorAll('pre code').forEach((el) =\u003e {\n    hljs.highlightElement(el);\n  });\n  document.querySelectorAll('table').forEach(function(table) {\n    if (!table.hasAttribute('Tablesort')) {\n      new Tablesort(table);\n      table.setAttribute('Tablesort', '');\n    }\n  });\n}\nif (DOMContentLoaded_fired) {\n  runWhenDOMContentLoaded();\n}\n\u003c/script\u003e\n\u003cscript\u003e\ndocument.addEventListener('DOMContentLoaded',function(){\n  DOMContentLoaded_fired=true;\n  runWhenDOMContentLoaded();\n});\n\u003c/script\u003e\n{% endblock %}\n\n{%- block footer_ext %}\n  \u003cp class=\"w3-right w3-tiny\"\u003e\n  {%- if i18n_config and i18n_page_file_locale %}\n    \u003ca href=\"{{ (i18n_page_locale + '/imprint/') | url }}\"\u003eImprint\u003c/a\u003e\n  {%- else %}\n    \u003ca href=\"{{ 'imprint/' | url }}\"\u003eImpressum\u003c/a\u003e\n  {%- endif %}\n  \u003c/p\u003e\n{%- endblock %}\n\n{%- block top_buttons %}\n    \u003ca class=\"w3-button w3-theme-d1 w3-hover-theme w3-padding-small w3-right no-print\" href=\"{{ config.repo_url }}\" target=\"_blank\"\u003e\u0026lt;/\u0026gt;\u003c/a\u003e \n{%- endblock %}\n```\n\n## Page titles\n\nNormally `nav` page titles would override `#` heading or `title` meta tag.\nBut in this theme the `title` meta tag will always be used for the top panel if defined.\n\nFor example define the navigation:\n\n```yaml\nnav:\n    - Short title: 'index.md'\n```\n\nAnd within `index.md` you define the long title like this:\n\n```markdown\ntitle: Long long long title\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funverbuggt%2Fmkdocs-risonia-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funverbuggt%2Fmkdocs-risonia-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funverbuggt%2Fmkdocs-risonia-theme/lists"}