Skip to content

Commit

Permalink
docs: add note on Composer installation in changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
johannschopplich committed Mar 29, 2024
1 parent 912b194 commit 5477994
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
24 changes: 11 additions & 13 deletions content/1.docs/1.live-preview/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,19 @@ description: Learn how to install and configure the plugin in your Kirby project

### Step 1: Install the Plugin

#### Download

After your purchase, you will receive a download link for the Kirby Live Preview plugin. Download the ZIP file and extract it to your `site/plugins` folder. It should look like this:

```
site/plugins/
├─ kirby-live-preview/
│ ├─ … All plugin files
```

#### Composer :u-badge{label="v1.2.1+" class="align-middle ml-2 !rounded-full" variant="subtle"}

The easiest and recommended way to install the plugin is via Composer. Since it's not available through Packagist, you have to connect to our private repository [repo.kirby.tools](https://repo.kirby.tools) and authenticate your package download. Authentication is done via a license code that you can get from the [Kirby Tools Hub](https://hub.kirby.tools) after your purchase.
The recommended way to install the plugin is via Composer. Since it's not available through Packagist, you have to connect to our private repository [repo.kirby.tools](https://repo.kirby.tools) and authenticate your package download. Authentication is done via a license code that you can get from the [Kirby Tools Hub](https://hub.kirby.tools) after your purchase.

To get access to the private repository and enable Composer installs, follow these steps:

Expand Down Expand Up @@ -61,18 +71,6 @@ Now you can manage the Kirby Live Preview plugin just like any other plugin, e.g
composer update
```

#### Download

After your purchase, you will receive a download link for the Kirby Live Preview plugin. Download the ZIP file and extract it to your `site/plugins` folder. It should look like this:

```
site/plugins/
├─ kirby-live-preview/
│ ├─ index.js
│ ├─ index.php
│ ├─ … other plugin files
```

### Step 2: Blueprint Setup

Select a site or page blueprint to which you want to add the Live Preview section. Add the following section configuration to the blueprint file:
Expand Down
2 changes: 1 addition & 1 deletion content/1.docs/1.live-preview/4.changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Get to know the latest changes and updates to the plugin.

## Where to Find the Latest Version?

You can then download the latest version from your [order page](https://app.lemonsqueezy.com/my-orders) on Lemon Squeezy.
You can then download the latest version from your [order page](https://app.lemonsqueezy.com/my-orders) on Lemon Squeezy or run `composer update` if you have set up the [private Composer repository](/docs/live-preview#composer).

## What's New?

Expand Down

0 comments on commit 5477994

Please sign in to comment.