Skip to content

Commit b753c6f

Browse files
authored
First draft of the SCSS readme
1 parent c740ba2 commit b753c6f

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

src/scss/README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
TBF
1+
# App.css split into SCSS
2+
3+
This is the current release app.css, split into SCSS partials. This folder can be deleted locally if you do not wish to keep it.
4+
5+
## Features
6+
7+
Gentle nesting. Because we are using scripts to pull out the partials, and then coming in and selecting some selectors to nest, we want to make sure any nesting we do here in these doesn't end up compiling into a CSS file that does not match the source app.css. As such, it is currently limited to `@media` and `rtl` selectors. You are encouraged to add more nesting yourself, if you prefer so.
8+
9+
An [_examples.scss](_examples.scss) to introduce you to some of the common things you can do with SASS and building your theme.
10+
11+
`@use` and `@forward` built in to the partials and compiled file.
12+
13+
## How to use this
14+
15+
> [!NOTE]
16+
> If you use an IDE, your IDE may already contain a compiler. The instructions are for those editing by hand below.
17+
18+
Install [SASS](https://sass-lang.com) through the package manager of your choice, or compile direct from Github. If you use an IDE, your IDE may already
19+
20+
In the terminal, point SASS to watch `/` folder and recompile as you make changesUse the command:
21+
```bash
22+
sass --watch src/scss/theme.scss:theme.css
23+
```
24+
25+
If you wish a `no-map` version, use the command:
26+
27+
```bash
28+
sass --watch --no-source-map src/scss/theme.scss:theme.css
29+
```
30+
31+
Make your changes to your SCSS files, and SASS will recompile.
32+
33+
> [!TIP]
34+
> You can also have `theme.css` compile directly to your `.obsidian/themes/theme-folder-here` for testing. Just reload Obsidian to check all your chases.

0 commit comments

Comments
 (0)