Skip to content

Commit 07c9d21

Browse files
productdevbookproductdevbook
authored
feat: new docs (#560)
* feat: docs * chore: update vitepress config * chore: fix ci * chore: update docs build * chore: delete component * chore: update docs * chore: upgrade deps * chore: update package name * fix: installationtabs * chore: delete old page * fix: select * fix: docs * fix: code * fix: build * chore: upgrade docs * chore: change tsconfig * chore: fix ci * fix: ci * chore: move `.docs` folder * chore: update readme * chore: delete .cache * chore: update docs * chore: update color * chore: update nuxt playground
1 parent a1123c5 commit 07c9d21

File tree

470 files changed

+25398
-23088
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

470 files changed

+25398
-23088
lines changed

‎.docs/.gitignore‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.docs/.npmrc‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎.docs/.vitepress/components/Announcement.vue‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<script setup lang="ts">
2+
import { useData } from 'vitepress'
3+
4+
const { frontmatter: fm } = useData()
5+
</script>
6+
7+
<template>
8+
<a
9+
v-if="fm.hero.prelink"
10+
:href="fm.hero.prelink.link"
11+
:target="fm.hero.prelink.target"
12+
class="inline-flex items-center rounded-lg bg-[var(--vp-c-default-soft)] px-4 py-1 text-sm font-semibold mb-3"
13+
>
14+
{{ fm.hero.prelink.title }}
15+
</a>
16+
</template>

‎.docs/.vitepress/components/CardLink.vue‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<script setup lang="ts">
2+
import { AspectRatio } from '@oku-ui/primitives'
3+
4+
defineProps<{
5+
title: string
6+
description?: string
7+
url: string
8+
image?: string
9+
}>()
10+
</script>
11+
12+
<template>
13+
<div>
14+
<a
15+
class="flex flex-col bg-[var(--vp-c-bg-soft)] hover:bg-[var(--vp-c-bg-alt)] transition duration-300 rounded-xl p-4"
16+
target="_blank"
17+
:href="url"
18+
>
19+
<h5 class="font-bold">{{ title }}</h5>
20+
<p class="my-1 text-sm text-[var(--vp-c-text-2)]">{{ description }}</p>
21+
22+
<AspectRatio
23+
v-if="image"
24+
:ratio="16 / 9"
25+
class="rounded-md mt-2 overflow-hidden "
26+
>
27+
<img
28+
class="w-full h-full object-cover"
29+
:src="image"
30+
:alt="title"
31+
>
32+
</AspectRatio>
33+
34+
</a>
35+
</div>
36+
</template>

‎.docs/.vitepress/components/ComponentLoader.vue‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<script setup lang="ts">
2+
import { defineAsyncComponent } from 'vue'
3+
import Spinner from './Spinner.vue'
4+
5+
const props = defineProps<{
6+
name: string
7+
}>()
8+
9+
const Component = defineAsyncComponent({
10+
loadingComponent: Spinner,
11+
loader: () => import(`../../components/demo/${props.name}/tailwind/index.vue`),
12+
timeout: 5000,
13+
suspensible: false,
14+
})
15+
</script>
16+
17+
<template>
18+
<Component :is="Component" />
19+
</template>

‎.docs/.vitepress/components/ComponentPreview.vue‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<script setup lang="ts">
2+
import HeroContainer from './NewHeroContainer.vue'
3+
import HeroCodeGroup from './NewHeroCodeGroup.vue'
4+
import { computed } from 'vue'
5+
import { useStorage } from '@vueuse/core'
6+
7+
const props = defineProps<{
8+
name: string
9+
files?: string
10+
}>()
11+
12+
const cssFramework = useStorage<'css' | 'tailwind' | 'pinceau' >('cssFramework', 'tailwind')
13+
const parsedFiles = computed(() => JSON.parse(decodeURIComponent(props.files ?? ''))[cssFramework.value])
14+
</script>
15+
16+
<template>
17+
<HeroContainer
18+
:folder="name"
19+
:files="parsedFiles"
20+
:css-framework="cssFramework"
21+
>
22+
<slot />
23+
24+
<template #codeSlot>
25+
<HeroCodeGroup v-model="cssFramework">
26+
<slot name="tailwind" />
27+
<slot name="css" />
28+
</HeroCodeGroup>
29+
</template>
30+
</HeroContainer>
31+
</template>

‎.docs/.vitepress/components/Contributors.vue‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<script setup lang="ts">
2+
import { contributors } from '../contributors'
3+
</script>
4+
5+
<template>
6+
<div class="flex flex-wrap gap-2 justify-center">
7+
<a
8+
v-for="{ name, avatar } of contributors"
9+
:key="name"
10+
:href="`https://github.com/${name}`"
11+
class="m-0"
12+
rel="noopener noreferrer"
13+
:aria-label="`${name} on GitHub`"
14+
>
15+
<img
16+
loading="lazy"
17+
:src="avatar"
18+
width="50"
19+
height="50"
20+
class="rounded-full h-12 w-12"
21+
:alt="`${name}'s avatar`"
22+
>
23+
</a>
24+
</div>
25+
</template>

‎.docs/.vitepress/components/EmbedIframe.vue‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<script setup lang="ts">
2+
import { AspectRatio } from '@oku-ui/primitives'
3+
import { onMounted, ref } from 'vue'
4+
5+
defineOptions({
6+
inheritAttrs: false,
7+
})
8+
9+
defineProps<{ src: string }>()
10+
11+
const isMounted = ref(false)
12+
onMounted(() => {
13+
isMounted.value = true
14+
})
15+
</script>
16+
17+
<template>
18+
<AspectRatio>
19+
<iframe
20+
:src="src"
21+
class="w-full h-full"
22+
v-bind="$attrs"
23+
/>
24+
</AspectRatio>
25+
</template>

‎.docs/.vitepress/components/HomePage.vue‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<script setup lang="ts">
2+
import { VPTeamMembers } from 'vitepress/theme-without-fonts'
3+
import { teamMembers } from '../contributors'
4+
import Contributors from './Contributors.vue'
5+
</script>
6+
7+
<template>
8+
<div class="content px-6 sm:px-[48px] lg:px-[64px]">
9+
<div class="mx-auto w-full container max-w-[1152px]">
10+
<main class="w-full">
11+
<div class="vp-doc flex flex-col items-center mt-10">
12+
<h2
13+
id="meet-the-team"
14+
class="opacity-50 font-medium pt-10 pb-2"
15+
>
16+
Meet The Team
17+
</h2>
18+
<div class="w-full">
19+
<VPTeamMembers
20+
size="small"
21+
:members="teamMembers"
22+
/>
23+
</div>
24+
<h2
25+
id="the-team"
26+
class="op50 font-medium pt-5 pb-2"
27+
>
28+
Contributors
29+
</h2>
30+
<p class="text-lg max-w-200 text-center leading-7">
31+
<Contributors />
32+
<br>
33+
<a
34+
href="https://discord.gg/RCGzQQPtAh"
35+
rel="noopener noreferrer"
36+
>Join the community</a> and get involved!
37+
</p>
38+
</div>
39+
</main>
40+
</div>
41+
</div>
42+
</template>

‎.docs/.vitepress/components/HomePageDemo.vue‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<script setup lang="ts">
2+
import Demos from '../../components/Demos.vue'
3+
</script>
4+
5+
<template>
6+
<div class="mt-12 md:mt-24 content px-6 sm:px-[48px] lg:px-[64px]">
7+
<div class="mx-auto w-full container max-w-[1152px]">
8+
<Demos class="grid w-auto lg:grid-cols-2 gap-6 md:gap-12 lg:gap-6" />
9+
</div>
10+
</div>
11+
</template>

0 commit comments

Comments
 (0)