Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 1.13 KB

themes.md

File metadata and controls

24 lines (14 loc) · 1.13 KB

Theming in Miaou

For now, themes don't apply to the mobile version of Miaou. The reason is nobody probably wants to do all the tests you need to do in order to buid a global theme applying to all parts.

How to create a theme

  1. You can't test anything without having installed the Miaou server. Fortunately it's easy enough (see main readme)
  2. Create a directory in /themes/. The name of the directory will be the public name of the theme
  3. That directory should contain a file named variables.scss in which you'll override the necessary variables (variables are defined in /src/main-scss/variables-default.scss)
  4. Compile Miaou using miaou-builder css
  5. Register your theme in /config.json
  6. Restart the server using /restart.sh

Scss Variables

A theme may only set SCSS variables. No direct CSS rule is allowed. Except when it is.

Of course !important is forbidden.

When something doesn't seem possible or convenient enough because there's no suitable variable, the common style and variables list may be changed by the core developpers.

These limitations make it possible to have Miaou still evolving and being maintained.