Skip to content

Commit

Permalink
docs: add utm links
Browse files Browse the repository at this point in the history
  • Loading branch information
Baroshem committed Jun 27, 2024
1 parent 2662a7a commit 69862cd
Show file tree
Hide file tree
Showing 9 changed files with 82 additions and 79 deletions.
11 changes: 7 additions & 4 deletions docs/content/1.getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,13 @@ export default defineNuxtConfig({
CLOUDINARY_CLOUD_NAME=<YOUR_CLOUDINARY_CLOUD_NAME>
```

::callout{icon="i-heroicons-check-circle"}
And that's it! You can now use Clodinary in Nuxt ✨
::callout{icon="i-heroicons-light-bulb" to="https://cloudinary.com/users/register_free?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary" target="_blank"}
Don't have a Cloudinary account? Sign up for free on cloudinary.com!
::

And that's it! You can now use Clodinary in Nuxt ✨


```vue
<template>
<CldImage
Expand Down Expand Up @@ -99,13 +102,13 @@ Enabling Cloudinary analytics.

- Default: `-`

Top level configuration used for all composables and components. Check out all available options [here](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters)
Top level configuration used for all composables and components. Check out all available options [here](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary)

### `url`

- Default: `-`

Top level configuration used for all composables and components. Check out all available options [here](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters)
Top level configuration used for all composables and components. Check out all available options [here](https://cloudinary.com/documentation/cloudinary_sdks#configuration_parameters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary)

## NuxtCloudinary vs Nuxt Image

Expand Down
122 changes: 61 additions & 61 deletions docs/content/2.components/CldImage/2.configuration.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content/2.components/CldMediaLibrary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description:
---

The CldMediaLibrary creates a media gallery element that uses an instance of the [Cloudinary Media Library Widget](https://cloudinary.com/documentation/media_library_widget) to give you an easy way to add media librarry component to your Nuxt app.
The CldMediaLibrary creates a media gallery element that uses an instance of the [Cloudinary Media Library Widget](https://cloudinary.com/documentation/media_library_widget?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) to give you an easy way to add media librarry component to your Nuxt app.

## Basic Usage

Expand Down Expand Up @@ -35,7 +35,7 @@ CldMediaLibrary accepts several customization props listed below:
| useSaml | boolean | `false` |
| params | object | `{}` |

For all other available props checkout [Cloudinary Media Gallery Docs](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) and make sure to pass them to the component as `params` like following:
For all other available props checkout [Cloudinary Media Gallery Docs](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) and make sure to pass them to the component as `params` like following:

```vue
<script setup lang="ts">
Expand Down
4 changes: 2 additions & 2 deletions docs/content/2.components/CldProductGallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description:
---

The CldProductGallery creates a product gallery element that uses an instance of the [Cloudinary Product Gallery Widget](https://cloudinary.com/documentation/product_gallery_reference) to give you an easy way to add product gallery component to your Nuxt app.
The CldProductGallery creates a product gallery element that uses an instance of the [Cloudinary Product Gallery Widget](https://cloudinary.com/documentation/product_gallery_reference?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) to give you an easy way to add product gallery component to your Nuxt app.

## Basic Usage

Expand Down Expand Up @@ -42,7 +42,7 @@ CldProductGallery accepts several customization props listed below:
| zoom | boolean | `false` |
| params | object | `{}` |

For all other available props checkout [Cloudinary Product Gallery Docs](https://cloudinary.com/documentation/product_gallery_reference#widget_parameters) and make sure to pass them to the component as `params` like following:
For all other available props checkout [Cloudinary Product Gallery Docs](https://cloudinary.com/documentation/product_gallery_reference#widget_parameters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) and make sure to pass them to the component as `params` like following:

```vue
<script setup lang="ts">
Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.components/CldUploadButton.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description:
---

The CldUploadButton creates a button element that uses an instance of the [Cloudinary Upload Widget](https://cloudinary.com/documentation/upload_widget) to give you an easy way to add upload capabilities to your Nuxt app.
The CldUploadButton creates a button element that uses an instance of the [Cloudinary Upload Widget](https://cloudinary.com/documentation/upload_widget?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) to give you an easy way to add upload capabilities to your Nuxt app.

The CldUploadButton component wraps the [CldUploadWidget](/components/clduploadwidget) component providing a pre-defined UI (a button). The same concepts apply, including having the option of using Signed or Unsigned uploads.

Expand Down
6 changes: 3 additions & 3 deletions docs/content/2.components/CldUploadWidget.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description:
---

The CldUploadWidget creates a new instance of the [Cloudinary Upload Widget](https://cloudinary.com/documentation/upload_widget) giving you an easy way to add upload capabilities to your Nuxt app.
The CldUploadWidget creates a new instance of the [Cloudinary Upload Widget](https://cloudinary.com/documentation/upload_widget?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) giving you an easy way to add upload capabilities to your Nuxt app.

## Basic Usage

Expand All @@ -11,7 +11,7 @@ The CldUploadWidget will not render any UI by default. It will instead only rend
There are two options when using the CldUploadWidget: signed and unsigned. These options allow you to control the amount of security and restrictions you place on uploads.

::callout{icon="i-heroicons-light-bulb"}
To learn more about signed and unsigned upload, check out the [Cloudinary docs](https://cloudinary.com/documentation/upload_images#uploading_assets_to_the_cloud).
To learn more about signed and unsigned upload, check out the [Cloudinary docs](https://cloudinary.com/documentation/upload_images#uploading_assets_to_the_cloud?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary).
::

### Unsigned
Expand Down Expand Up @@ -97,7 +97,7 @@ To use the above, create a Node-based API route, add the snippet, and use that e
| onTags | function | `(result, options) => { }` |
| onUploadAdded | function | `(result, options) => { }` |

To learn more about the event callbacks and when they trigger, see: https://cloudinary.com/documentation/upload_widget_reference#events
To learn more about the event callbacks and when they trigger, [see](https://cloudinary.com/documentation/upload_widget_reference#events?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary)

### Callback Options

Expand Down
8 changes: 4 additions & 4 deletions docs/content/2.components/CldVideoPlayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:

## The usage

The CldVideoPlayer component helps to embed Cloudinary videos using the [Cloudinary Video Player](https://cloudinary.com/documentation/cloudinary_video_player) giving you a full customizable experience for your player.
The CldVideoPlayer component helps to embed Cloudinary videos using the [Cloudinary Video Player](https://cloudinary.com/documentation/cloudinary_video_player?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) giving you a full customizable experience for your player.

## Basic Usage

Expand Down Expand Up @@ -83,7 +83,7 @@ Picture-in-picture helps your viewers continue their multitasking agenda and mai

## Chapters

Adding a button to select chapters (you can pass `chapters` prop as a boolean if the video already has chapters as explained [here](https://cloudinary.com/documentation/video_player_customization#video_chapters)).
Adding a button to select chapters (you can pass `chapters` prop as a boolean if the video already has chapters as explained [here](https://cloudinary.com/documentation/video_player_customization#video_chapters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary)).

```html
<script setup lang="ts">
Expand Down Expand Up @@ -111,7 +111,7 @@ Adding a button to select chapters (you can pass `chapters` prop as a boolean if

| Prop Name | Type | Default | Description | Example |
| ---------------------- | -------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| autoPlay | string | `"never"` | When, if, should the video automatically play. See `autoplayMode` in [Video Player docs](https://cloudinary.com/documentation/video_player_api_reference#constructor_parameters) | `"on-scroll"` |
| autoPlay | string | `"never"` | When, if, should the video automatically play. See `autoplayMode` in [Video Player docs](https://cloudinary.com/documentation/video_player_api_reference#constructor_parameters?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) | `"on-scroll"` |
| className | string | - | Additional class names added to the video container | `"my-video-player"` |
| colors | object | See below | Player chrome colors | See Colors Below |
| controls | boolean | `true` | Show player controls | `true` |
Expand Down Expand Up @@ -149,7 +149,7 @@ The `colors` prop takes an object that can control what colors are used in the p
| base | string | `"#000000"` | Player controls bar, information bar, central play button, and right-click context menu. |
| text | string | `"#FFFFFF"` | All the text and icons that are present within the video player UI. |

Learn more about the color scheme options and how they're used [on the Cloudinary docs](https://cloudinary.com/documentation/video_player_customization#color_scheme).
Learn more about the color scheme options and how they're used [on the Cloudinary docs](https://cloudinary.com/documentation/video_player_customization#color_scheme?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary).

## Event Props

Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.composables/1.useCldImageUrl.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ All effect props are disabled by default.
| vibrance | bool/string | `true`, `"70"` |
| vignette | bool/string | `true`, `"30"` |

[View the Cloudinary docs](https://cloudinary.com/documentation/transformation_reference#e_effect) to see learn more about using effects.
[View the Cloudinary docs](https://cloudinary.com/documentation/transformation_reference#e_effect?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary) to see learn more about using effects.

### Overlay Options

Expand Down
2 changes: 1 addition & 1 deletion docs/content/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ features:
target: '_blank'
- title: 'Cloudinary URL Loader'
icon: 'i-simple-icons-cloudinary'
to: 'https://cloudinary.com'
to: 'https://cloudinary.com?utm_campaign=devx_nuxtcloudinary&utm_medium=referral&utm_source=nuxtcloudinary'
target: '_blank'
- title: 'Optimized images in modern formats'
icon: 'i-heroicons-photo'
Expand Down

0 comments on commit 69862cd

Please sign in to comment.