Merge pull request #981 from basics/feature/docs

docs update

docs/src/components/booster-layer.md

@@ -106,6 +106,10 @@ The layer can be closed via a `for` attribute with the `id` `nuxt-booster-layer-
       <li id="nuxt-booster-message-weak-hardware">
         weak hardware
       </li>
+      <!-- Displayed when the user batteries are not sufficient.  -->
+      <li id="nuxt-booster-message-low-battery">
+        low battery
+      </li>
     </ul>
 
     <!-- Button to hide the layer with no javascript -->

docs/src/components/booster-picture.md

@@ -103,7 +103,7 @@ List of resources used.
 
 The definitions in the `sources` are equivalent to the [`BoosterImage (source)`](/components/booster-image#source).
 
-The only differences are:
+With the exception of:
 
 - The `media` property can be used. This allows even more dependencies for the display, e.g. `(orientation: portrait)`.
 - The `format` property is not used. Instead `formats` is used for setting the output formats.

docs/src/components/booster-vimeo.md

@@ -12,19 +12,17 @@ So that no empty space is visible to the user, we use the functionality of the [
 
 The `BoosterVimeo` is used to initialise Vimeo videos with [`Vimeo Player-SDK`](https://developer.vimeo.com/player/sdk/).  
 
-::: info
-The SDK is not part of `nuxt-booster` and will be loaded by an external script.
-:::
+> The `Vimeo Player-SDK` is not part of `nuxt-booster` and will be loaded by an external script. [Learn more](https://github.com/basics/nuxt-booster/blob/main/src/runtime/components/BoosterVimeo/utils/loader.js)
 
 The `url` of the Vimeo video must be specified.  
 
-The `BoosterPicture` is used for the poster, so the generation of the poster is automated, you can define the image sizes with [`sizes` (What is `sizes`?)](/components/booster-image#source).
+The `BoosterPicture` is used for the poster, so the generation of the poster is automated, you can define the image sizes with [`sizes` (What is sizes?)](/components/booster-image#source).
 
 [Learn more about `BoosterPicture`](/components/booster-picture)
 
-::alert{type="warning"}
+::: warning
 Important: For using `BoosterVimeo` do not disable `@nuxt/image` via `disableNuxtImage`
-::
+:::
 
 ### Example
 

docs/src/components/booster-youtube.md

@@ -10,11 +10,13 @@ So that no empty space is visible to the user, we use the functionality of the [
 
 ## Usage
 
-The `BoosterYoutube`is used to initialise Youtube videos with [Youtube Iframe-API](https://developers.google.com/youtube/iframe_api_reference?hl=de).
+The `BoosterYoutube`is used to initialise Youtube videos with [`Youtube Iframe-API`](https://developers.google.com/youtube/iframe_api_reference?hl=de).
+
+> The `Youtube Iframe-API` is not part of `nuxt-booster` and will be loaded by an external script. [Learn more](https://github.com/basics/nuxt-booster/blob/main/src/runtime/components/BoosterYoutube/utils/loader.js)
 
 The `url` of the Youtube video must be specified.  
 
-The `BoosterPicture` is used for the poster, so the generation of the poster is automated, you can define the image sizes with [`sizes` (What is `sizes`?)](/components/booster-picture#sources).
+The `BoosterPicture` is used for the poster, so the generation of the poster is automated, you can define the image sizes with [`sizes` (What is sizes?)](/components/booster-picture#sources).
 
 [Learn more about `BoosterPicture`](/components/booster-picture)
 

docs/src/guide/setup.md

@@ -13,11 +13,11 @@ Install `nuxt-booster` as a dependency to your project:
 ::: code-group
 
   ```bash [Yarn]
-  yarn add nuxt-booster@next
+  yarn add nuxt-booster
   ```
 
   ```bash [NPM]
-  npm install nuxt-booster@next
+  npm install nuxt-booster
   ```
 
 :::

docs/src/v2/components/booster-picture.md

@@ -93,7 +93,7 @@ List of resources used.
 
 The definitions in the `sources` are equivalent to the [`BoosterImage (source)`](/v2/components/booster-image#source).
 
-The only differences are:
+With the exception of:
 
 - The `media` property can be used. This allows even more dependencies for the display, e.g. `(orientation: portrait)`.
 - The `format` property is not used. Instead `formats` is used for setting the output formats.

docs/src/v2/components/booster-vimeo.md

@@ -12,9 +12,7 @@ So that no empty space is visible to the user, we use the functionality of the [
 
 The `BoosterVimeo` is used to initialise Vimeo videos with [`Vimeo Player-SDK`](https://developer.vimeo.com/player/sdk/).  
 
-::: tip
-The SDK is not part of `nuxt-booster` and will be loaded by an external script.
-:::
+> The `Vimeo Player-SDK` is not part of `nuxt-booster` and will be loaded by an external script. [Learn more](https://github.com/basics/nuxt-booster/blob/main/src/runtime/components/BoosterVimeo/utils/loader.js)
 
 The `url` of the Vimeo video must be specified.  
 

docs/src/v2/components/booster-youtube.md

@@ -10,7 +10,9 @@ So that no empty space is visible to the user, we use the functionality of the [
 
 ## Usage
 
-The `BoosterYoutube`is used to initialise Youtube videos with [Youtube Iframe-API](https://developers.google.com/youtube/iframe_api_reference?hl=de).
+The `BoosterYoutube`is used to initialise Youtube videos with [`Youtube Iframe-API`](https://developers.google.com/youtube/iframe_api_reference?hl=de).
+
+> The `Youtube Iframe-API` is not part of `nuxt-booster` and will be loaded by an external script. [Learn more](https://github.com/basics/nuxt-booster/blob/main/src/runtime/components/BoosterYoutube/utils/loader.js)
 
 The `url` of the Youtube video must be specified.  
 
@@ -19,7 +21,6 @@ The `BoosterPicture` is used for the poster, so the generation of the poster is
 [Learn more about `BoosterPicture`](/v2/components/booster-picture)
 
 ::: warning
-
 Important: For using `BoosterYoutube` do not disable `@nuxt/image` via `disableNuxtImage`.
 :::
 

docs/src/v2/guide/setup.md

@@ -13,11 +13,11 @@ Install `nuxt-booster` as a dependency to your project:
 ::: code-group
 
   ```bash [Yarn]
-  yarn add nuxt-booster
+  yarn add nuxt-booster@2
   ```
 
   ```bash [NPM]
-  npm install nuxt-booster
+  npm install nuxt-booster@2
   ```
 
 :::