Skip to content
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.

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

Move publish views to its own section #109

Merged
merged 1 commit into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ export default defineConfig({
text: '🛠️ Expanding PowerGrid',
items: [
{ text: 'Perfomance Monitoring', link: '/expanding-powergrid/performance-monitoring' },
{ text: 'Publish Views', link: '/expanding-powergrid/publish-views' },
{ text: 'Custom Theme', link: '/expanding-powergrid/custom-theme' },
],
collapsed: false
Expand Down
32 changes: 32 additions & 0 deletions docs/expanding-powergrid/publish-views.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Publish Views

This section covers publishing PowerGrid views.

Here you will find:

[[toc]]

## Introduction

Just like in any Laravel package, PowerGrid views are publishable and may be customized to fit your needs.

PowerGrid Blade Views are more complex than standard HTML-CSS template files. These files contain application code and logic that is regularly updated to introduce new features and address bugs.

In short, publishing views means that PowerGrid original Blade views will be copied from PowerGrid's `vendor` directory into the directory `resources/views/vendor/livewire-powergrid`.

As a consequence, from this point on, your application will load the copied version, which remains **unchanged/outdated**, instead of the latest version from PowerGrid.

## Publishing Views

::: danger ❗ WARNING

Be aware that publishing Blade views may result in **BREAKING CHANGES** to your application.

**DO NOT proceed** if you don't have a clear understanding of the potential risks involved.
:::

To publish views, run the command:

```bash
php artisan vendor:publish --tag=livewire-powergrid-views
```
10 changes: 0 additions & 10 deletions docs/get-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,6 @@ php artisan vendor:publish --tag=livewire-powergrid-config

This subsection covers optional installations steps.

These steps are only necessary if you wish to customize PowerGrid resources.

### Publish Views

To publish Views, run the following command:

```bash
php artisan vendor:publish --tag=livewire-powergrid-views
```

### Publish Translations

To publish PowerGrid translation (language) files, run the following command:
Expand Down