From 1bc75494cae6efd5a0fdff3195db110451bad2ec Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Thu, 11 Jun 2020 22:40:36 -0700 Subject: Split documentation into separate files --- docs/developement.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/developement.md (limited to 'docs/developement.md') 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"; +``` -- cgit v1.2.3