From 31a64ab28feb29c31bf1248177278d9341b9adc3 Mon Sep 17 00:00:00 2001 From: lukinovec Date: Tue, 4 Oct 2022 19:49:49 +0200 Subject: [PATCH] Document the ViteBundler feature (#209) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Document the ViteBundler feature * Fix formatting * Remove Vite integration page, make links to the integration page link to the feature page * Add example for enabling the feature * improve writing Co-authored-by: Samuel Ć tancl --- navigation.php | 2 ++ source/docs/v3/features/vite-bundler.blade.md | 18 ++++++++++++++++++ source/docs/v3/integrating.blade.md | 1 + source/docs/v3/optional-features.blade.md | 2 ++ 4 files changed, 23 insertions(+) create mode 100644 source/docs/v3/features/vite-bundler.blade.md diff --git a/navigation.php b/navigation.php index 1f1befb..fb894b7 100644 --- a/navigation.php +++ b/navigation.php @@ -156,6 +156,7 @@ return [ 'Tenant Config' => 'features/tenant-config', 'Cross-domain redirect' => 'features/cross-domain-redirect', 'Universal routes' => 'features/universal-routes', + 'Vite bundler' => 'features/vite-bundler', ], ], ], @@ -207,6 +208,7 @@ return [ 'Livewire' => 'integrations/livewire', 'Orchid' => 'integrations/orchid', 'Sanctum' => 'integrations/sanctum', + 'Vite' => 'features/vite-bundler', ], ], 'Console commands' => 'console-commands', diff --git a/source/docs/v3/features/vite-bundler.blade.md b/source/docs/v3/features/vite-bundler.blade.md new file mode 100644 index 0000000..8015a34 --- /dev/null +++ b/source/docs/v3/features/vite-bundler.blade.md @@ -0,0 +1,18 @@ +--- +title: Vite bundler +extends: _layouts.documentation +section: content +--- + +# Vite bundler {#vite-bundler} + +Enabling the `ViteBundler` feature makes Vite generate correct asset paths by using the `global_asset()` helper instead of the default `asset()` helper. + +To enable the feature, uncomment `Stancl\Tenancy\Features\ViteBundler::class` in the `features` section of the tenancy config: + +```php +'features' => [ + // [...] + Stancl\Tenancy\Features\ViteBundler::class, +], +``` diff --git a/source/docs/v3/integrating.blade.md b/source/docs/v3/integrating.blade.md index 1f3d9dc..cd3f8b4 100644 --- a/source/docs/v3/integrating.blade.md +++ b/source/docs/v3/integrating.blade.md @@ -16,3 +16,4 @@ If you're using the [automatic mode]({{ $page->link('automatic-mode') }}) & [mul - [Laravel Telescope]({{ $page->link('integrations/telescope') }}) - [Livewire]({{ $page->link('integrations/livewire') }}) - [Laravel Sanctum]({{ $page->link('integrations/sanctum') }}) +- [Vite]({{ $page->link('features/vite-bundler') }}) diff --git a/source/docs/v3/optional-features.blade.md b/source/docs/v3/optional-features.blade.md index 8b8b9e4..f4875ed 100644 --- a/source/docs/v3/optional-features.blade.md +++ b/source/docs/v3/optional-features.blade.md @@ -13,6 +13,8 @@ section: content - [`TenantConfig`]({{ $page->link('features/tenant-config') }}) for mapping keys from the tenant storage into the application config - [`CrossDomainRedirect`]({{ $page->link('features/cross-domain-redirect') }}) for adding a `domain()` macro on `RedirectResponse` letting you change the intended hostname of the generated route - [`UniversalRoutes`]({{ $page->link('features/universal-routes') }}) for route actions that work in both the central & tenant context +- [`ViteBundler`]({{ $page->link('features/vite-bundler') }}) for making Vite generate the correct asset paths + All of the package's Features are in the `Stancl\Tenancy\Features` namespace. You may register features by adding their class names to the `tenancy.features` config.