Skip to content

Commit

Permalink
code review
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech committed Dec 13, 2024
1 parent 67af359 commit d730f4c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Find all the guides and resources you need to develop with Clerk.
---

- [Vue](/docs/quickstarts/vue)
- Get started installing and initializing Clerk in a new Vite Vue App.
- Get started installing and initializing Clerk in a new Vue + Vite app.
- {<svg viewBox="0 0 196.32 170.02"><path fill="#42b883" d="M120.83 0L98.16 39.26 75.49 0H0l98.16 170.02L196.32 0h-75.49z"/><path fill="#35495e" d="M120.83 0L98.16 39.26 75.49 0H39.26l58.9 102.01L157.06 0h-36.23z"/></svg>}
</Cards>

Expand Down
8 changes: 4 additions & 4 deletions docs/quickstarts/vue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Clerk's Vue SDK provides prebuilt components and composables to make it easy to

### Install `@clerk/vue`

Clerk's Vue SDK gives you access to prebuilt components, composables, and helpers to make user authentication easier.
Clerk's [Vue SDK](/docs/references/vue/overview) gives you access to prebuilt components, composables, and helpers to make user authentication easier.

Run the following command to install the SDK:

Expand Down Expand Up @@ -120,7 +120,7 @@ Clerk's Vue SDK provides prebuilt components and composables to make it easy to

### Add `clerkPlugin` to your app

The `clerkPlugin` Vue plugin provides active session and user context to Clerk's components and composables. When adding the plugin, pass your Publishable Key as an option.
`clerkPlugin` provides active session and user context to Clerk's components and composables. It's required to pass your Publishable Key as an option.

```ts {{ filename: 'src/main.ts', mark: [4, [12, 14]] }}
import { createApp } from 'vue'
Expand All @@ -141,14 +141,14 @@ Clerk's Vue SDK provides prebuilt components and composables to make it easy to

### Create a header with Clerk components

You can control which content signed-in and signed-out users can see with the [prebuilt control components](/docs/components/overview#what-are-control-components). Create a header using the following components:
You can control which content signed-in and signed-out users can see with Clerk's [prebuilt control components](/docs/components/overview#what-are-control-components). The following example creates a header using the following components:

- [`<SignedIn>`](/docs/components/control/signed-in): Children of this component can only be seen while **signed in**.
- [`<SignedOut>`](/docs/components/control/signed-out): Children of this component can only be seen while **signed out**.
- [`<UserButton />`](/docs/components/user/user-button): Shows the signed-in user's avatar. Selecting it opens a dropdown menu with account management options.
- [`<SignInButton />`](/docs/components/unstyled/sign-in-button): An unstyled component that links to the sign-in page or displays the sign-in modal.

```vue {{ filename: 'src/App.vue', mark: [2, [7, 12]] }}
```vue {{ filename: 'src/App.vue', mark: [2, [6, 13]] }}
<script setup lang="ts">
import { SignedIn, SignedOut, SignInButton, UserButton } from '@clerk/vue'
</script>
Expand Down

0 comments on commit d730f4c

Please sign in to comment.