Skip to content

docs: further documentation on the SCSS load path #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 24, 2022
Merged

docs: further documentation on the SCSS load path #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80d0c5b
Update getStarted.adoc
mfranzke Oct 24, 2022
7ef85c3
Update migrationGuide.adoc
mfranzke Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/getStarted.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ This should add a new entry to your `package.json` file:
@import "@db-ui/core/sources/css/enterprise/db-ui-core";
----

### SCSS: `node_modules include path / load path

Please keep in mind, that you would need to set your `include path` also known as `load path` depending on your setup for the sass compiler to find the correct `node_modules` folder, e.g. like the following (this is similar to how other frameworks and libraries like link:https://github.com/twbs/bootstrap-npm-starter/blob/main/package.json#L18[Bootstrap] are handling this):

#### link:https://npmjs.com/sass[`sass` compiler]
Expand Down
2 changes: 2 additions & 0 deletions docs/migrationGuide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Especially the following aspects have changed through the various different rele

Please note that we've switched from the deprecated link:https://www.npmjs.com/package/node-sass[`node-sass`] compiler to its successor link:https://www.npmjs.com/package/sass[`sass`]. As `sass` doesn't support the tilde (`~`) reference to your `node_modules` folder out of the box and there even also doesn't seem to be a general solution out there, we've removed that one, so that in case you're using our SCSS sources directly, you would need to provide your `node_modules` folder as a load path or include path (e.g. `--load-path=node_modules` on the `sass` CLI usage).

You need to set the load path / include path depending on your SCSS compiler as described within our link:getStarted.adoc#scss-node_modules-include-path--load-path[getting started]

Additionally we've deprecated the `@db-ui/core/sources/css/enterprise/db-ui-core-include` SCSS endpoint – please either `@import` the file `@db-ui/core/sources/css/rollup.assets-paths` or `@db-ui/core/sources/css/webpack.assets-paths` depending on your bundler, previous to `@import`ing `@db-ui/core/sources/css/enterprise/db-ui-core` directly from now on.

==== SCSS Helper functions
Expand Down