X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fdevelopement.md;fp=docs%2Fdevelopement.md;h=6ea1cba1379064c17e72f025a3faf3956f5247e4;hb=1bc75494cae6efd5a0fdff3195db110451bad2ec;hp=0000000000000000000000000000000000000000;hpb=cad54a560f77382d9584fd804f9cdd84c92012b7;p=github%2Fbastienwirtz%2Fhomer.git 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 @@ +## Developement + +```sh +# Using yarn (recommended) +yarn install +yarn serve + +# **OR** Using npm +npm install +npm run serve +``` + +### Themes + +Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)). +To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-` scope. Then import it in the main style file. + +```scss +// `src/assets/themes/my-awesome-theme.scss` +body #app.theme-my-awesome-theme. { ... } +``` + +```scss +// `src/assets/app.scss` +// Themes import +@import "./themes/sui.scss"; +... +@import "./themes/my-awesome-theme.scss"; +```