Skip to content

Commit

Permalink
docs: πŸ“šοΈ πŸ“ update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
woldtwerk committed May 13, 2024
1 parent 3f7a6ff commit 9129fe2
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions packages/vite-plugin-drupal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Add it to your theme with:
pnpm i -D @ueberbit/vite-plugin-drupal
```

## Features
## Features
- automagic asset bundling
- batteries included:
- preconfigured for tailwind and postcss
Expand Down Expand Up @@ -54,6 +54,11 @@ is an entrypoint and also a drupal library. An exception to this are files insid
```
, files starting with an _underscore and file ending with `*.ce.*`.

#### SDC
Drupal automatically attaches the css and js file with the same name as the sdc. Thus you can add the files you want to be transpiled to the assets, src, js or css folder.

The resulting library will be attached by the companion module.

### Custom Element Loader
Files ending with `*.{eager|idle|lazy|visible}.ce.*` are auto injected by the custom element loader.
Any of these files is auto imported and registered as `<themename>-filename`.
Expand All @@ -67,7 +72,7 @@ Any of these files is auto imported and registered as `<themename>-filename`.

### Custom Element Data

Custom Element Data is exported into .uebertool
Custom Element Data is exported into .uebertool
You can add it to vscode with:

```json
Expand All @@ -79,7 +84,7 @@ You can add it to vscode with:
### CSS

#### Cascade Layers
Tailwind Layers are wrapped in cascade layers by dafault. Drupal styles should be wrapped with
Tailwind Layers are wrapped in cascade layers by dafault. Drupal styles should be wrapped with
```css
@layer drupal
```
Expand Down Expand Up @@ -117,4 +122,4 @@ Drupal types are available. Including types for some internals like drupal/once.
Do fun stuff with konami code:
```ts
document.addEventListener('konami', funStuff)
```
```

0 comments on commit 9129fe2

Please sign in to comment.