@electronic-minds/adventure-scss
Version:
Adventure Scss Utilities
36 lines (27 loc) • 1.46 kB
Markdown
# Adventure Scss Utilities
This package serves as the foundation for all other Adventure components but it can be the base of your project, too.
Have a look at [adventure.docs.lan/scss/](http://adventure.docs.lan/scss/) for an extended API documentation.
## Install
```sh
npm i @electronic-minds/adventure-scss
```
## Usage
```scss
@use "@electronic-minds/adventure-scss" as adventure;
```
Use provided configuration mixin to configure your global project defaults.
```scss
@include adventure.configure(...);
```
See [/src/_config.scss](src/_config.scss) for all possible configuration options.
## Examples
Let's say you want your blockquotes to always use the quotation marks associated with the current language.
```scss
blockquote {
@include adventure.quotes();
}
```
## Hinweis zur Verwendung in PHPStorm
Damit PHPStorm `node_modules`-Pfade korrekt auflösen kann, müssen Vorkehrungen getroffen werden.
Gehe in deine PHPStorm `Settings` und öffne dort den Punkt `Directories`. Dort findest du nun eine Übersicht aller Projekt-Ordner. Mache einen Rechtsklick auf `node_modules` und wähle `Resource Root` als Option aus.
Werden dir in deinen Projekt-Dateien keine `node_modules` angezeigt, so blendest du sie ein, indem du das kleine Zahnrad am oberen Rand des Dateibaums klickst und das `Options menu` öffnest. Dort kannst du unter `Tree Appearance` mittels Klick auf `Show Excluded Files` die ausgeblendeten Dateien wieder einblenden.