diff options
Diffstat (limited to 'docs/developement.md')
-rw-r--r-- | docs/developement.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/developement.md b/docs/developement.md new file mode 100644 index 0000000..6ea1cba --- /dev/null +++ b/docs/developement.md | |||
@@ -0,0 +1,29 @@ | |||
1 | ## Developement | ||
2 | |||
3 | ```sh | ||
4 | # Using yarn (recommended) | ||
5 | yarn install | ||
6 | yarn serve | ||
7 | |||
8 | # **OR** Using npm | ||
9 | npm install | ||
10 | npm run serve | ||
11 | ``` | ||
12 | |||
13 | ### Themes | ||
14 | |||
15 | Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)). | ||
16 | To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file. | ||
17 | |||
18 | ```scss | ||
19 | // `src/assets/themes/my-awesome-theme.scss` | ||
20 | body #app.theme-my-awesome-theme. { ... } | ||
21 | ``` | ||
22 | |||
23 | ```scss | ||
24 | // `src/assets/app.scss` | ||
25 | // Themes import | ||
26 | @import "./themes/sui.scss"; | ||
27 | ... | ||
28 | @import "./themes/my-awesome-theme.scss"; | ||
29 | ``` | ||