Clean up exported data
This commit is contained in:
10
README.md
10
README.md
@@ -23,23 +23,23 @@ npm install git+https://git.maze.io/maze/cyberduck.git#main
|
||||
|
||||
Note: when installing from a git repository, npm will clone the source. For consumers to get built artifacts (the `dist` bundle and compiled types) the repository must either include the `dist` output or provide a `prepare`/build step that runs on install. If you prefer not to publish, using `npm pack` from the repo owner (tarball) ensures the built `dist` is included.
|
||||
|
||||
## Including styles
|
||||
## Including styles (optional)
|
||||
|
||||
CyberDuck emits a single bundled stylesheet. Preferred import options:
|
||||
Styles are optional — CyberDuck does not automatically inject styles when you import components. Import styles only if you want the theme and utilities applied.
|
||||
|
||||
- Import the packaged CSS via the package export (recommended):
|
||||
- Recommended (package export):
|
||||
|
||||
```ts
|
||||
import 'cyberduck/css'
|
||||
```
|
||||
|
||||
- Import the compiled CSS file directly (older setups):
|
||||
- Direct CSS file (older setups):
|
||||
|
||||
```ts
|
||||
import 'cyberduck/dist/cyberduck.css'
|
||||
```
|
||||
|
||||
- If you want to include and compile the SCSS source in your app (allows customization), import the SCSS entry:
|
||||
- Compile and include SCSS in your app (for customization):
|
||||
|
||||
```scss
|
||||
@use 'cyberduck/styles/cyberduck.scss' as *;
|
||||
|
||||
Reference in New Issue
Block a user