@deviceinsight/scale-semantic-ui-theme
v1.6.0
Published
= Scale UI - Semantic UI Theme
Readme
= Scale UI - Semantic UI Theme
This repository contains a custom theme of Semantic UI based on https://github.com/fomantic/Fomantic-UI[Fomantic UI] - the fork of semantic UI that is actively maintained.
== How to work with the theme
To build the theme, execute the following command:
[source:bash]
yarn build
Note: The build process uses gulp to build the custom theme because it is recommended by fomantic-ui (see https://fomantic-ui.com/introduction/build-tools.html).
== Theme customization
Any customizations of the theme should be done in the semantic/src/site folder.
The best approach of modifying the theme is first to try
to achieve the desired result by changing the variable file of a component.
The variable file needs to be here: /semantic/src/site/{category}/{component}.variables.
If the modification of the variables is not enough to achieve the desired styles, custom styles of the component can be added in a /semantic/src/site/{category}/{component}.overrides file.
In this file, a developer can write custom less styles for the component.
After updating the theme, a rebuild is necessary to see the changes.
== Component definitions
The component style is stored in the /semantic/src/definition folder.
Treat this folder as a reference on how the component is built, but please don't change anything there,
because it's autogenerated by fomantic-ui and the files there can be changed after upgrading fomantic-ui.
The less stylesheet for a component can be found here: /semantic/src/definitions/{category}/{component}.less.
