Skip to content

Commit

Permalink
Added notice for disabling default stubs (#202)
Browse files Browse the repository at this point in the history
Co-authored-by: Luke Towers <[email protected]>
  • Loading branch information
jaxwilko and LukeTowers authored Jul 19, 2024
1 parent 4d83149 commit 71e5173
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions console/asset-compilation-mix.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ By default, the `mix:config` command will only generate the basic `winter.mix.js
- `--tailwind` will configure your package for [tailwindcss](https://tailwindcss.com/)
- `--vue` will configure your package for [vue.js](https://vuejs.org/)

The `--stubs` flag will tell Winter to automatically pre-populate css/js files with a basic setup of your chosen libraries.

For example, the following with configure the plugin `Acme.Example` with tailwind and create `plugins/acme/example/assets/src/acme-example.css` with a tailwind setup.

```bash
php artisan mix:config acme.example --tailwind --stubs
php artisan mix:config acme.example --tailwind
```

> **NOTE:** Winter will automatically pre-populate CSS/JS files with a basic setup of your chosen libraries. If you wish to only have the base configuration files generated then use the `--no-stubs` option.

## Manual Mix configuration

The Mix configuration file (`winter.mix.js`) is a configuration file that manages the configuration of Laravel Mix itself. In conjunction with the `package.json` file that defines your dependencies, this file defines how Laravel Mix will compile your assets.
Expand Down
6 changes: 3 additions & 3 deletions console/asset-compilation-vite.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ By default, the `vite:config` command will only generate the basic `vite.config.
- `--tailwind` will configure your package for [tailwindcss](https://tailwindcss.com/)
- `--vue` will configure your package for [vue.js](https://vuejs.org/)

The `--stubs` flag will tell Winter to automatically pre-populate css/js files with a basic setup of your chosen libraries.

For example, the following with configure the plugin `Acme.Example` with tailwind and create `plugins/acme/example/assets/src/acme-example.css` with a tailwind setup.

```bash
php artisan vite:config acme.example --tailwind --stubs
php artisan vite:config acme.example --tailwind
```

> **NOTE:** Winter will automatically pre-populate CSS/JS files with a basic setup of your chosen libraries. If you wish to only have the base configuration files generated then use the `--no-stubs` option.

## Manual Vite configuration

The Vite configuration file (`vite.config.mjs`) is a configuration file that manages the configuration of Laravel Vite itself. In conjunction with the `package.json` file that defines your dependencies, this file defines how Laravel Vite will compile your assets.
Expand Down

0 comments on commit 71e5173

Please sign in to comment.