Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
docs: use LinkExample as block component
Browse files Browse the repository at this point in the history
  • Loading branch information
farnabaz committed Oct 25, 2022
1 parent 54da6f8 commit 31acd53
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 16 deletions.
3 changes: 2 additions & 1 deletion docs/content/1.getting-started/5.seo-meta.md
Expand Up @@ -239,7 +239,8 @@ useHead({
</script>
```

:LinkExample{link="/examples/composables/use-head"}
::LinkExample{link="/examples/composables/use-head"}
::

:ReadMore{link="/guide/directory-structure/pages/#page-metadata"}

Expand Down
6 changes: 4 additions & 2 deletions docs/content/1.getting-started/6.data-fetching.md
Expand Up @@ -32,7 +32,8 @@ const { data: count } = await useFetch('/api/count')
</template>
```

:LinkExample{link="/examples/composables/use-fetch"}
::LinkExample{link="/examples/composables/use-fetch"}
::

## `useLazyFetch`

Expand Down Expand Up @@ -98,7 +99,8 @@ const { data } = await useAsyncData('count', () => $fetch('/api/count'))
</template>
```

:LinkExample{link="/examples/composables/use-async-data"}
::LinkExample{link="/examples/composables/use-async-data"}
::

## `useLazyAsyncData`

Expand Down
6 changes: 4 additions & 2 deletions docs/content/1.getting-started/7.state-management.md
Expand Up @@ -53,7 +53,8 @@ const counter = useState('counter', () => Math.round(Math.random() * 1000))
</template>
```

:LinkExample{link="/examples/composables/use-state"}
::LinkExample{link="/examples/composables/use-state"}
::

::ReadMore{link="/api/composables/use-state"}
::
Expand All @@ -62,7 +63,8 @@ const counter = useState('counter', () => Math.round(Math.random() * 1000))

In this example, we use a composable that detects the user's default locale from the HTTP request headers and keeps it in a `locale` state.

:LinkExample{link="/examples/other/locale"}
::LinkExample{link="/examples/other/locale"}
::

## Shared State

Expand Down
3 changes: 2 additions & 1 deletion docs/content/1.getting-started/8.error-handling.md
Expand Up @@ -158,4 +158,5 @@ If you navigate to another route, the error will be cleared automatically.
</template>
```

:LinkExample{link="/examples/app/error-handling"}
::LinkExample{link="/examples/app/error-handling"}
::
3 changes: 2 additions & 1 deletion docs/content/2.guide/2.directory-structure/1.components.md
Expand Up @@ -283,4 +283,5 @@ export default {
It will automatically import the components only if used and also support HMR when updating your components in `node_modules/awesome-ui/components/`.
:LinkExample{link="/examples/auto-imports/components"}
::LinkExample{link="/examples/auto-imports/components"}
::
3 changes: 2 additions & 1 deletion docs/content/2.guide/2.directory-structure/1.composables.md
Expand Up @@ -46,7 +46,8 @@ const foo = useFoo()
</script>
```

:LinkExample{link="/examples/auto-imports/composables"}
::LinkExample{link="/examples/auto-imports/composables"}
::

## Examples

Expand Down
3 changes: 2 additions & 1 deletion docs/content/2.guide/2.directory-structure/1.layouts.md
Expand Up @@ -131,7 +131,8 @@ definePageMeta({
</script>
```

:LinkExample{link="/examples/routing/layouts"}
::LinkExample{link="/examples/routing/layouts"}
::

## Overriding a Layout on a Per-page Basis

Expand Down
3 changes: 2 additions & 1 deletion docs/content/2.guide/2.directory-structure/1.middleware.md
Expand Up @@ -94,4 +94,5 @@ definePageMeta({

Now, before navigation to that page can complete, the `auth` route middleware will be run.

:LinkExample{link="/examples/routing/middleware"}
::LinkExample{link="/examples/routing/middleware"}
::
3 changes: 2 additions & 1 deletion docs/content/2.guide/2.directory-structure/1.pages.md
Expand Up @@ -220,7 +220,8 @@ definePageMeta({
</script>
```

:LinkExample{link="/examples/routing/pages"}
::LinkExample{link="/examples/routing/pages"}
::

## Page Metadata

Expand Down
3 changes: 2 additions & 1 deletion docs/content/2.guide/2.directory-structure/1.plugins.md
Expand Up @@ -179,4 +179,5 @@ export default defineNuxtPlugin((nuxtApp) => {

:ReadMore{link="https://vuejs.org/guide/reusability/custom-directives.html"}

:LinkExample{link="/examples/app/plugins"}
::LinkExample{link="/examples/app/plugins"}
::
3 changes: 2 additions & 1 deletion docs/content/3.api/1.composables/use-cookie.md
Expand Up @@ -157,4 +157,5 @@ export default defineEventHandler(event => {
})
```

:LinkExample{link="/examples/composables/use-cookie"}
::LinkExample{link="/examples/composables/use-cookie"}
::
3 changes: 2 additions & 1 deletion docs/content/3.api/1.composables/use-fetch.md
Expand Up @@ -111,4 +111,5 @@ const { data, pending, error, refresh } = await useFetch('/api/auth/login', {

:ReadMore{link="/getting-started/data-fetching"}

:LinkExample{link="/examples/composables/use-fetch"}
::LinkExample{link="/examples/composables/use-fetch"}
::
3 changes: 2 additions & 1 deletion docs/content/3.api/2.components/4.nuxt-link.md
Expand Up @@ -124,4 +124,5 @@ defineNuxtLink({
- **exactActiveClass**: A default class to apply on exact active links. Works the same as [Vue Router's `linkExactActiveClass` option](https://router.vuejs.org/api/#linkexactactiveclass). Defaults to Vue Router's default (`"router-link-exact-active"`)
- **prefetchedClass**: A default class to apply to links that have been prefetched.

:LinkExample{link="/examples/routing/nuxt-link"}
::LinkExample{link="/examples/routing/nuxt-link"}
::
3 changes: 2 additions & 1 deletion docs/content/3.api/2.components/8.teleports.md
Expand Up @@ -37,4 +37,5 @@ The `to` target of [`<Teleport>`](https://vuejs.org/guide/built-ins/teleport.htm
</template>
```

:LinkExample{link="/examples/app/teleport"}
::LinkExample{link="/examples/app/teleport"}
::

0 comments on commit 31acd53

Please sign in to comment.