Skip to content

Commit

Permalink
docs(update): fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
ThornWalli committed Nov 10, 2023
1 parent 9e78106 commit 2dd2cab
Show file tree
Hide file tree
Showing 20 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/src/guide/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following NuxtJS settings are made or overwritten in the `nuxt.config`:

- Type: `Object`

These options can be used to define the initial checks to display the [`SpeedkitLayer`](/guide/components/speedkit-layer). The prerequisite are that the [`SpeedkitLayer`](/components/speedkit-layer) has been embedded into the layout.
These options can be used to define the initial checks to display the [`SpeedkitLayer`](/components/speedkit-layer). The prerequisite are that the [`SpeedkitLayer`](/components/speedkit-layer) has been embedded into the layout.

````js
{
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Introduction
::: tip You are reading the documentation for Nuxt Speedkit (v3)!

- **Nuxt Speedkit (v2)** documentation has been moved to [nuxt-speedkit.grabarzundpartner.dev/v2/](https://nuxt-speedkit.grabarzundpartner.dev/v2/).
- Upgrading from **Nuxt Speedkit (v2)** ? Check out the [Migration Guide](/migration/v3/).
- Upgrading from **Nuxt Speedkit (v2)** ? Check out the [Migration Guide](/migration/v3).
:::

**Nuxt Speedkit** takes over the lighthouse performance optimization of your generated website.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/migration/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ With `v2` the documentation was changed. You can find the previous version [here

The `speedkitComponents` property is removed from skeleton.

Instead, the [`SpeedkitHydrate`](/v2/usage#import-components) is now used as a function wrapper.
Instead, the [`SpeedkitHydrate`](/v2/guide/usage#import-components) is now used as a function wrapper.

**<span style="color: red;">old (v1)</span>**

Expand Down
2 changes: 1 addition & 1 deletion docs/src/v1/components/experimental/speedkit-picture.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ In the following example, two different image ratios are used.

Set component as critical component.

[Learn more about critical components](/usage#critical-prop-for-critical-components)
[Learn more about critical components](/guide/usage#critical-prop-for-critical-components)

### `alt`

Expand Down
8 changes: 4 additions & 4 deletions docs/src/v1/components/experimental/speedkit-youtube.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ title: SpeedkitYoutube (Experimental)
We have integrated `SpeedkitYoutube` (Experimental) as an example to show how iFrame content must be integrated in a performance-optimized manner.
For this purpose, a separate IntersectionObserver has been implemented, which detects a longer dwell time of the component in the viewport. The iFrame is initialized only after a positive detection. This prevents immense data from having to be loaded when simply scrolling through the page.
So that no empty space is visible to the user, we use the functionality of the [`SpeedkitPicture` (Experimental)](/v1/components/experimental-speedkit-picture) and preload the corresponding Youtube poster in different renditions, so the illusion is perfect for the user and he does not notice anything of the optimized lazy load procedure.
So that no empty space is visible to the user, we use the functionality of the [`SpeedkitPicture` (Experimental)](/v1/components/experimental/speedkit-picture) and preload the corresponding Youtube poster in different renditions, so the illusion is perfect for the user and he does not notice anything of the optimized lazy load procedure.

::: warning
`SpeedkitYoutube` (Experimental) is based on the component [`SpeedkitPicture` (Experimental)](/v1/components/experimental-speedkit-picture). We hope that with the final completion of [`@nuxt/image`](https://image.nuxtjs.org/) we will be able to modify this component and can use `@nuxt/image` & `NuxtPicture` with full functionality.
`SpeedkitYoutube` (Experimental) is based on the component [`SpeedkitPicture` (Experimental)](/v1/components/experimental/speedkit-picture). We hope that with the final completion of [`@nuxt/image`](https://image.nuxtjs.org/) we will be able to modify this component and can use `@nuxt/image` & `NuxtPicture` with full functionality.
:::

## Usage

The `SpeedkitYoutube` (Experimental) is used to initialise Youtube videos with Youtube-API only when they are in the visible viewport.

The `id` of the Youtube video and the appropriate viewport dependent widths must be specified in [`sizes` (What is `sizes`?)](/v1/components/experimental-speedkit-picture#sources).
The `id` of the Youtube video and the appropriate viewport dependent widths must be specified in [`sizes` (What is `sizes`?)](/v1/components/experimental/speedkit-picture#sources).
The `SpeedkitPicture` (Experimental) is used for the poster, so the generation of the poster is automated.

[Learn more about `SpeedkitPicture` (Experimental)](/v1/components/experimental-speedkit-picture)
[Learn more about `SpeedkitPicture` (Experimental)](/v1/components/experimental/speedkit-picture)

### Example

Expand Down
2 changes: 1 addition & 1 deletion docs/src/v1/components/speedkit-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ When an event is triggered, the relevant message is displayed via the ID using t

| ID | Description |
| ---------------------------------------------------------- | --------------------------------------------------------------------------- |
| <nobr>`nuxt-speedkit__message__unsupported-browser`</nobr> | User Browser is not supported by [`Browserslist`](/v1/options#browsersupport). |
| <nobr>`nuxt-speedkit__message__unsupported-browser`</nobr> | User Browser is not supported by [`Browserslist`](/v1/guide/options#browsersupport). |
| <nobr>`nuxt-speedkit__message__outdated-device`</nobr> | User hardware (number of processor & RAM) are not sufficient. |
| <nobr>`nuxt-speedkit__message__slow-connection`</nobr> | Connection speed is too low. |

Expand Down
8 changes: 4 additions & 4 deletions docs/src/v1/components/speedkit-picture.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: SpeedkitPicture

# {{$frontmatter.title}}

Since the [`SpeedkitPicture` (Experimental)](/v1/components/experimental-speedkit-picture) is still marked as experimental, we still offer the simplified version called `SpeedkitPicture`. Here, all resources that are generated fully automatically in the experimental module must be defined manually.
Since the [`SpeedkitPicture` (Experimental)](/v1/components/experimental/speedkit-picture) is still marked as experimental, we still offer the simplified version called `SpeedkitPicture`. Here, all resources that are generated fully automatically in the experimental module must be defined manually.

Except for the manual resource definition, all other [features](/v1/components/experimental-speedkit-picture#features) of [`SpeedkitPicture` (Experimental)](/v1/components/experimental-speedkit-picture) are identical.
Except for the manual resource definition, all other [features](/v1/components/experimental/speedkit-picture#features) of [`SpeedkitPicture` (Experimental)](/v1/components/experimental/speedkit-picture) are identical.

## Usage

Expand Down Expand Up @@ -89,7 +89,7 @@ export default {

All properties except [`sources`](/v1/components/speedkit-picture#sources) and [`placeholders`](/v1/components/speedkit-picture#placeholders) are identical to the `SpeedkitPicture` (Experimental).

Learn more about [`ExperimentalSpeedkitPicture` - Properties](/v1/components/experimental-speedkit-picture#properties).
Learn more about [`ExperimentalSpeedkitPicture` - Properties](/v1/components/experimental/speedkit-picture#properties).

### `sources`

Expand Down Expand Up @@ -225,4 +225,4 @@ Make sure that the placeholders have a width of `30px` and are optimized.

## Events

More on events at [`SpeedkitPicture` (Experimental) - Events](/v1/components/experimental-speedkit-picture#events).
More on events at [`SpeedkitPicture` (Experimental) - Events](/v1/components/experimental/speedkit-picture#events).
10 changes: 5 additions & 5 deletions docs/src/v1/components/speedkit-youtube.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ title: SpeedkitYoutube

> Please note the privacy policy when using. [Google Youtube-API](https://developers.google.com/youtube/v3) is integrated via dependency [`youtube-player`](https://www.npmjs.com/package/youtube-player).
Since the [`SpeedkitYoutube` (Experimental)](/v1/components/experimental-speedkit-youtube) is still marked as experimental, we still offer the simplified version called `SpeedkitYoutube`. Here, all resources that are generated fully automatically in the experimental module must be defined manually.
Since the [`SpeedkitYoutube` (Experimental)](/v1/components/experimental/speedkit-youtube) is still marked as experimental, we still offer the simplified version called `SpeedkitYoutube`. Here, all resources that are generated fully automatically in the experimental module must be defined manually.

Except for the manual resource definition for the poster, all other [features](/v1/components/experimental-speedkit-youtube#features) of [`SpeedkitYoutube` (Experimental)](/v1/components/experimental-speedkit-youtube) are identical.
Except for the manual resource definition for the poster, all other [features](/v1/components/experimental/speedkit-youtube#features) of [`SpeedkitYoutube` (Experimental)](/v1/components/experimental/speedkit-youtube) are identical.

## Usage

The `SpeedkitYoutube` differs from the [`SpeedkitYoutube` (Experimental)](/v1/components/experimental-speedkit-youtube) in the definition of the `poster`.
The `SpeedkitYoutube` differs from the [`SpeedkitYoutube` (Experimental)](/v1/components/experimental/speedkit-youtube) in the definition of the `poster`.
A `SpeedkitPicture` must be additionally defined in the `poster` property.

[Learn more about `SpeedkitPicture`](/v1/components/speedkit-picture)
Expand Down Expand Up @@ -93,7 +93,7 @@ export default {

All properties except `poster` are identical to `SpeedkitYoutube`.

Learn more about [`SpeedkitYoutube` (Experimental) - Properties](/v1/components/experimental-speedkit-youtube#events).
Learn more about [`SpeedkitYoutube` (Experimental) - Properties](/v1/components/experimental/speedkit-youtube#events).

### `poster`

Expand All @@ -104,4 +104,4 @@ Poster is displayed as long as the player is not playing.

## Events

More on events at [`SpeedkitYoutube` (Experimental) - Events](/v1/components/experimental-speedkit-youtube#events).
More on events at [`SpeedkitYoutube` (Experimental) - Events](/v1/components/experimental/speedkit-youtube#events).
6 changes: 3 additions & 3 deletions docs/src/v1/guide/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ These options can be used to define which initial checks are to be carried out w

| Key | Type | Required | Description | Default |
| ---------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| `performance` | `Boolean` | yes | Checks whether the minimum [performance requirement](/v1/options#performancemetrics) has been met. If this is not the case, the [`SpeedkitLayer`](/v1/components/speedkit-layer) is displayed. | `true` |
| `performance` | `Boolean` | yes | Checks whether the minimum [performance requirement](/v1/guide/options#performancemetrics) has been met. If this is not the case, the [`SpeedkitLayer`](/v1/components/speedkit-layer) is displayed. | `true` |
| `browserSupport` | `Boolean` | yes | Überprüft, ob die Webseite über einen supported Browser besucht wird. Handelt es sich hierbei um einen unsupported Browser, wird der [`SpeedkitLayer`](/v1/components/speedkit-layer) eingeblendet. | `true` |

::alert{type="info"}
Expand Down Expand Up @@ -252,5 +252,5 @@ If set, `@nuxt/image` will not be integrated.

⚠️&nbsp;&nbsp;The following components can no longer be used:<br>

- [SpeedkitPicture (Experimental)](/v1/components/experimental-speedkit-picture)
- [SpeedkitYoutube (Experimental)](/v1/components/experimental-speedkit-youtube)
- [SpeedkitPicture (Experimental)](/v1/components/experimental/speedkit-picture)
- [SpeedkitYoutube (Experimental)](/v1/components/experimental/speedkit-youtube)
2 changes: 1 addition & 1 deletion docs/src/v1/guide/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ Then, add `nuxt-speedkit` to the `modules` section of `nuxt.config.js`:
}
````

See [module options](/v1/options).
See [module options](/v1/guide/options).
4 changes: 2 additions & 2 deletions docs/src/v1/guide/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ In order to be able to load further static resources such as pictures, iFrames o

- [SpeedkitLayer](/v1/components/speedkit-layer)
- [SpeedkitPicture](/v1/components/speedkit-picture)
- [SpeedkitPicture (Experimental)](/v1/components/experimental-speedkit-picture)
- [SpeedkitPicture (Experimental)](/v1/components/experimental/speedkit-picture)
- [SpeedkitIframe](/v1/components/speedkit-iframe)
- [SpeedkitYoutube](/v1/components/speedkit-youtube)
- [SpeedkitYoutube (Experimental)](/v1/components/experimental-speedkit-youtube)
- [SpeedkitYoutube (Experimental)](/v1/components/experimental/speedkit-youtube)

````html
<template>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/v1/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Introduction
[Module](https://www.npmjs.com/package/nuxt-speedkit) for [NuxtJS](https://nuxtjs.org).

::: warning
You are reading Nuxt Speedkit v1 docs. [For Nuxt 3 go to the v3 docs](/v3)
You are reading Nuxt Speedkit v1 docs. [For Nuxt 3 go to the v3 docs](/)
:::

Nuxt Speedkit takes over the lighthouse performance optimization of your generated website.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/v2/components/speedkit-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Image Title.

If not set, the global crossorigin is used `this.$speedkit.crossorigin`.

[Learn more about `crossorigin` option](/v2/options#crossorigin)
[Learn more about `crossorigin` option](/v2/guide/options#crossorigin)

[MDN - HTML.Attributes.crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin)

Expand All @@ -209,7 +209,7 @@ If not set, the global crossorigin is used `this.$speedkit.crossorigin`.

Set component as critical component.

[Learn more about critical components](/v2/usage#critical-prop-for-critical-components)
[Learn more about critical components](/v2/guide/usage#critical-prop-for-critical-components)

## Events

Expand Down
6 changes: 3 additions & 3 deletions docs/src/v2/components/speedkit-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If the SpeedkitLayer is implemented, the javascript initialisation is automatica
occurs, the process is paused and only continued or cancelled after a user interaction in the layer.

The layer is placed once in the layout (e.g. `layouts/default.vue`).
The included SpeedkitLayer serves as a wrapper and must be filled according to the [template](/v2/v2/components/speedkit-layer#template), see [example component](https://github.com/GrabarzUndPartner/nuxt-speedkit/blob/main/example/components/InfoLayer.vue).
The included SpeedkitLayer serves as a wrapper and must be filled according to the [template](/v2/components/speedkit-layer#template), see [example component](https://github.com/GrabarzUndPartner/nuxt-speedkit/blob/main/example/components/InfoLayer.vue).

The content contains messages and buttons that are displayed in the respective event.
Messages and buttons are defined with an `id`, these are set to `display: none;` by default via CSS.
Expand All @@ -25,7 +25,7 @@ Messages and buttons are defined with an `id`, these are set to `display: none;`
- e.g. `nuxt-speedkit-button-init-app` for button

::: tip
For the closing mechanism of the layer, see [Hide Layer](/v2/v2/components/speedkit-layer#hide-layer).
For the closing mechanism of the layer, see [Hide Layer](/v2/components/speedkit-layer#hide-layer).
:::

## Messages
Expand All @@ -40,7 +40,7 @@ When an event is triggered, the relevant message is displayed via the ID using t
| <nobr>`nuxt-speedkit-message-nojs`</nobr> | Javascript is disabled. |
| <nobr>`nuxt-speedkit-message-reduced-bandwidth`</nobr> | Connection bandwidth is too low. |
| <nobr>`nuxt-speedkit-message-weak-hardware`</nobr> | User hardware are not sufficient. |
| <nobr>`nuxt-speedkit-message-unsupported-browser`</nobr> | User Browser is not supported by [`Browserslist`](/v2/options#browsersupport). |
| <nobr>`nuxt-speedkit-message-unsupported-browser`</nobr> | User Browser is not supported by [`Browserslist`](/v2/guide/options#browsersupport). |

**Example**

Expand Down
4 changes: 2 additions & 2 deletions docs/src/v2/components/speedkit-picture.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ In the following example, two different image ratios are used.
- Type: `Array`
- Default: `['webp', 'avif', 'jpg|jpeg|png|gif']`

> Overrides the [`pictureFormats`](/v2/options#pictureformats) property defined in the module options.
> Overrides the [`pictureFormats`](/v2/guide/options#pictureformats) property defined in the module options.
Defines the formats that are to be generated and provided as source in the Picture.
Is used to offer the correct image type for the browser.
Expand Down Expand Up @@ -175,7 +175,7 @@ This is made possible by [`sort-css-media-queries`](https://www.npmjs.com/packag

Set component as critical component.

[Learn more about critical components](/v2/usage#critical-prop-for-critical-components)
[Learn more about critical components](/v2/guide/usage#critical-prop-for-critical-components)

## Events

Expand Down
2 changes: 1 addition & 1 deletion docs/src/v2/components/speedkit-vimeo.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Sets the title for the player iframe and poster.
- Type: `Boolean`
- Default: `false`

When set starts video in autoplay. It is required that the component is integrated via [`SpeedkitHydrate`](/v2/usage#import-components) or is only activated when entering the visible area.
When set starts video in autoplay. It is required that the component is integrated via [`SpeedkitHydrate`](/v2/guide/usage#import-components) or is only activated when entering the visible area.

### `mute`

Expand Down
2 changes: 1 addition & 1 deletion docs/src/v2/components/speedkit-youtube.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Sets the title for the player iframe and poster.
- Type: `Boolean`
- Default: `false`

When set starts video in autoplay. It is required that the component is integrated via [`SpeedkitHydrate`](/v2/usage#import-components) or is only activated when entering the visible area.
When set starts video in autoplay. It is required that the component is integrated via [`SpeedkitHydrate`](/v2/guide/usage#import-components) or is only activated when entering the visible area.

### `mute`

Expand Down
4 changes: 2 additions & 2 deletions docs/src/v2/directives/v-font.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: v-font

# {{$frontmatter.title}}

The directive `v-font` is used to integrate the fonts defined in the [module options](/v2/options#fonts) into the website.
The directive `v-font` is used to integrate the fonts defined in the [module options](/v2/guide/options#fonts) into the website.

To do this, the respective font must be retrieved via the `$getFont` method contained in the component scope (e.g. `this`).

Expand All @@ -14,7 +14,7 @@ Normally the directive activates the fonts only when the viewport is reached.
It is recommended to use the property `critical` for components that are already initially contained in the viewport.

With critical component the fonts are preloaded and are initially active.
More information on critical components can be found [here](/v2/usage#critical-prop-for-critical-components).
More information on critical components can be found [here](/v2/guide/usage#critical-prop-for-critical-components).

For multiple fonts, a list (`Array`) can be passed.

Expand Down
Loading

0 comments on commit 2dd2cab

Please sign in to comment.