From 316eeea482a7654a73a2319579a5e7ec651b094d Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Wed, 22 May 2024 12:42:30 +0200 Subject: [PATCH] docs: start migration --- docs/app.vue | 71 +- docs/components/Banner.vue | 2 +- docs/components/BranchSelect.vue | 34 - docs/components/Footer.vue | 48 +- docs/components/Header.vue | 24 +- docs/components/Logo.vue | 6 +- docs/components/color-picker/ColorPicker.vue | 56 - .../color-picker/ColorPickerPill.vue | 25 - docs/components/releases/ReleasesItem.vue | 48 +- docs/composables/useContentSource.ts | 76 - docs/error.vue | 74 +- docs/layouts/docs.vue | 8 +- docs/modules/content-examples-code.ts | 10 +- docs/nuxt.config.ts | 118 +- docs/package.json | 23 +- docs/pages/[...slug].vue | 108 +- docs/pages/examples/[...slug].vue | 12 +- docs/pages/index.vue | 814 +++++----- docs/pages/releases.vue | 70 +- docs/plugins/ui.ts | 49 - docs/tailwind.config.ts | 30 - package.json | 7 +- playground/pages/index.vue | 5 +- pnpm-lock.yaml | 1378 ++++++----------- 24 files changed, 1125 insertions(+), 1971 deletions(-) delete mode 100644 docs/components/BranchSelect.vue delete mode 100644 docs/components/color-picker/ColorPicker.vue delete mode 100644 docs/components/color-picker/ColorPickerPill.vue delete mode 100644 docs/composables/useContentSource.ts delete mode 100644 docs/plugins/ui.ts delete mode 100644 docs/tailwind.config.ts diff --git a/docs/app.vue b/docs/app.vue index c8a8f7fa..88f2fa67 100644 --- a/docs/app.vue +++ b/docs/app.vue @@ -1,32 +1,3 @@ - - - + + diff --git a/docs/components/Banner.vue b/docs/components/Banner.vue index 86f08327..b4299d86 100644 --- a/docs/components/Banner.vue +++ b/docs/components/Banner.vue @@ -8,7 +8,7 @@ const hideBanner = () => { document.querySelector('html')?.classList.add('hide-banner') } -if (process.server) { +if (import.meta.server) { useHead({ script: [{ key: 'prehydrate-template-banner', diff --git a/docs/components/BranchSelect.vue b/docs/components/BranchSelect.vue deleted file mode 100644 index 676fa569..00000000 --- a/docs/components/BranchSelect.vue +++ /dev/null @@ -1,34 +0,0 @@ - - - diff --git a/docs/components/Footer.vue b/docs/components/Footer.vue index 6e5b0626..6c856647 100644 --- a/docs/components/Footer.vue +++ b/docs/components/Footer.vue @@ -1,29 +1,3 @@ - - + + diff --git a/docs/components/Header.vue b/docs/components/Header.vue index 99adfb80..484cddbb 100644 --- a/docs/components/Header.vue +++ b/docs/components/Header.vue @@ -10,37 +10,38 @@ - - + + @@ -54,7 +55,6 @@ defineProps<{ }>() const route = useRoute() -const { metaSymbol } = useShortcuts() const nav = inject>('navigation') diff --git a/docs/components/Logo.vue b/docs/components/Logo.vue index a2366190..3fa0f4ff 100644 --- a/docs/components/Logo.vue +++ b/docs/components/Logo.vue @@ -4,8 +4,8 @@ - - - + + + diff --git a/docs/components/color-picker/ColorPicker.vue b/docs/components/color-picker/ColorPicker.vue deleted file mode 100644 index e3d41f04..00000000 --- a/docs/components/color-picker/ColorPicker.vue +++ /dev/null @@ -1,56 +0,0 @@ - - - diff --git a/docs/components/color-picker/ColorPickerPill.vue b/docs/components/color-picker/ColorPickerPill.vue deleted file mode 100644 index f6c9e678..00000000 --- a/docs/components/color-picker/ColorPickerPill.vue +++ /dev/null @@ -1,25 +0,0 @@ - - - diff --git a/docs/components/releases/ReleasesItem.vue b/docs/components/releases/ReleasesItem.vue index ca813cd4..0d863dcb 100644 --- a/docs/components/releases/ReleasesItem.vue +++ b/docs/components/releases/ReleasesItem.vue @@ -1,27 +1,3 @@ - - + + diff --git a/docs/composables/useContentSource.ts b/docs/composables/useContentSource.ts deleted file mode 100644 index 4d727a21..00000000 --- a/docs/composables/useContentSource.ts +++ /dev/null @@ -1,76 +0,0 @@ -import pkg from '@nuxt/ui-pro/package.json' - -export const useContentSource = () => { - const route = useRoute() - const router = useRouter() - const config = useRuntimeConfig().public - - const branches = computed(() => [{ - id: 'main', - name: 'main', - label: 'nuxt/ui', - icon: 'i-heroicons-cube', - suffix: `v${config.version}`, - click: () => select({ name: 'main' }) - }, { - id: 'dev', - name: 'dev', - label: 'nuxt/ui-edge', - icon: 'i-heroicons-cube-transparent', - suffix: 'dev', - click: () => select({ name: 'dev' }) - }, { - id: 'pro', - name: 'pro', - label: 'nuxt/ui-pro', - icon: 'i-heroicons-cube', - suffix: `v${pkg.version.split('-')[0]}`, - click: () => select({ name: 'pro' }) - }, { - id: 'pro-edge', - name: 'pro-edge', - label: 'nuxt/ui-pro-edge', - icon: 'i-heroicons-cube-transparent', - suffix: 'dev', - disabled: true, - click: () => select({ name: 'pro-dev' }) - }]) - - const branch = computed(() => branches.value.find(b => b.name === (route.path.startsWith('/dev') ? 'dev' : route.path.startsWith('/pro') ? 'pro' : 'main'))) - - function select (b) { - if (b.name === branch.value.name) { - return - } - - if (b.name === 'pro') { - router.push('/pro/getting-started') - return - } - - if (branch.value.name === 'pro') { - if (b.name === 'dev') { - router.push('/dev/getting-started') - } else { - router.push('/getting-started') - } - - return - } - - if (b.name === 'dev') { - if (route.path.startsWith('/dev')) { - return - } - - router.push(`/dev${route.path}`) - } else { - router.push(route.path.replace('/dev', '')) - } - } - - return { - branches, - branch - } -} diff --git a/docs/error.vue b/docs/error.vue index 86ea3933..eca9bd7b 100644 --- a/docs/error.vue +++ b/docs/error.vue @@ -1,33 +1,3 @@ - - - + + diff --git a/docs/layouts/docs.vue b/docs/layouts/docs.vue index 05fc5bdb..70ea6517 100644 --- a/docs/layouts/docs.vue +++ b/docs/layouts/docs.vue @@ -3,11 +3,11 @@ diff --git a/docs/modules/content-examples-code.ts b/docs/modules/content-examples-code.ts index 16021f3e..985eb5c3 100644 --- a/docs/modules/content-examples-code.ts +++ b/docs/modules/content-examples-code.ts @@ -1,13 +1,7 @@ -import { - defineNuxtModule, - addTemplate, - addServerHandler, - createResolver -} from '@nuxt/kit' - import { existsSync, readFileSync } from 'fs' -import { dirname, join } from 'pathe' import fsp from 'fs/promises' +import { dirname, join } from 'pathe' +import { defineNuxtModule, addTemplate, addServerHandler, createResolver } from '@nuxt/kit' export default defineNuxtModule({ meta: { diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts index 4771a945..ada46a76 100644 --- a/docs/nuxt.config.ts +++ b/docs/nuxt.config.ts @@ -1,31 +1,23 @@ import { createResolver } from '@nuxt/kit' -import colors from 'tailwindcss/colors' import module from '../src/module' -import { excludeColors } from '../src/colors' import pkg from '../package.json' const { resolve } = createResolver(import.meta.url) export default defineNuxtConfig({ - // @ts-ignore - extends: process.env.NUXT_UI_PRO_PATH ? [ - process.env.NUXT_UI_PRO_PATH, - resolve(process.env.NUXT_UI_PRO_PATH, '.docs') - ] : [ - '@nuxt/ui-pro', - process.env.NUXT_GITHUB_TOKEN && ['github:nuxt/ui-pro/.docs#dev', { giget: { auth: process.env.NUXT_GITHUB_TOKEN } }] - ].filter(Boolean), + extends: [ + process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, 'docs') : process.env.NUXT_GITHUB_TOKEN && ['github:nuxt/ui-pro/docs#dev', { giget: { auth: process.env.NUXT_GITHUB_TOKEN } }] + ], modules: [ '@nuxt/content', '@nuxt/fonts', '@nuxt/image', - 'nuxt-og-image', module, + '@nuxt/ui-pro', '@nuxtjs/plausible', '@vueuse/nuxt', - 'nuxt-component-meta', - 'nuxt-cloudflare-analytics', - 'modules/content-examples-code' + 'nuxt-og-image', + // 'modules/content-examples-code' ], runtimeConfig: { public: { @@ -33,57 +25,27 @@ export default defineNuxtConfig({ } }, ui: { - global: true, - icons: ['heroicons', 'simple-icons'], - safelistColors: excludeColors(colors) + global: true }, content: { - highlight: { - langs: [ - 'postcss', - 'mdc' - ] - }, sources: { - dev: { - prefix: '/dev', - driver: 'fs', - base: resolve('./content') - }, - // overwrite default source AKA `content` directory - content: { - driver: 'github', - repo: 'nuxt/ui', - branch: 'main', - dir: 'docs/content' - }, pro: process.env.NUXT_UI_PRO_PATH ? { prefix: '/pro', driver: 'fs', - base: resolve(process.env.NUXT_UI_PRO_PATH, '.docs/content/pro') - } : process.env.NUXT_GITHUB_TOKEN ? { + base: resolve(process.env.NUXT_UI_PRO_PATH, 'docs/content/pro') + } : process.env.NUXT_GITHUB_TOKEN && { prefix: '/pro', driver: 'github', repo: 'nuxt/ui-pro', branch: 'dev', - dir: '.docs/content/pro', + dir: 'docs/content/pro', token: process.env.NUXT_GITHUB_TOKEN || '' - } : undefined + } } }, image: { provider: 'ipx' }, - fontMetrics: { - fonts: ['DM Sans'] - }, - googleFonts: { - display: 'swap', - download: true, - families: { - 'DM+Sans': [400, 500, 600, 700] - } - }, nitro: { prerender: { routes: [ @@ -94,48 +56,44 @@ export default defineNuxtConfig({ '/api/releases.json', '/api/pulls.json' ], - ignore: !process.env.NUXT_UI_PRO_PATH && !process.env.NUXT_GITHUB_TOKEN ? ['/pro'] : [] + ignore: !process.env.NUXT_GITHUB_TOKEN ? ['/pro'] : [] } }, routeRules: { - '/components': { redirect: '/components/accordion', prerender: false }, - '/dev/components': { redirect: '/dev/components/accordion', prerender: false } + '/components': { redirect: '/components/app', prerender: false }, + '/dev/components': { redirect: '/dev/components/app', prerender: false } }, componentMeta: { exclude: [ - '@nuxt/content', - '@nuxt/ui-templates', - '@nuxtjs/color-mode', - '@nuxtjs/mdc', - 'nuxt/dist', - 'nuxt-og-image', - 'nuxt-site-config', + // '@nuxt/content', + // '@nuxt/ui-templates', + // '@nuxtjs/color-mode', + // '@nuxtjs/mdc', + // 'nuxt/dist', + // 'nuxt-og-image', + // 'nuxt-site-config', resolve('./components'), - process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, '.docs', 'components') : '.c12' + // process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, 'docs', 'components') : '.c12' ], - metaFields: { - type: false, - props: true, - slots: true, - events: false, - exposed: false - } - }, - cloudflareAnalytics: { - token: '1e2b0c5e9a214f0390b9b94e043d8d4c', - scriptPath: false + // metaFields: { + // type: false, + // props: true, + // slots: true, + // events: false, + // exposed: false + // } }, hooks: { // Related to https://github.com/nuxt/nuxt/pull/22558 - 'components:extend': (components) => { - components.forEach((component) => { - if (component.shortPath.includes(process.env.NUXT_UI_PRO_PATH || '@nuxt/ui-pro')) { - component.global = true - } else if (component.global) { - component.global = 'sync' - } - }) - } + // 'components:extend': (components) => { + // components.forEach((component) => { + // if (component.shortPath.includes('@nuxt/ui-pro')) { + // component.global = true + // } else if (component.global) { + // component.global = 'sync' + // } + // }) + // } }, typescript: { strict: false diff --git a/docs/package.json b/docs/package.json index 17241752..a813636b 100644 --- a/docs/package.json +++ b/docs/package.json @@ -3,30 +3,27 @@ "private": true, "type": "module", "dependencies": { - "@iconify-json/heroicons": "^1.1.20", - "@iconify-json/simple-icons": "^1.1.98", + "@iconify-json/heroicons": "^1.1.21", + "@iconify-json/simple-icons": "^1.1.102", "@nuxt/content": "^2.12.1", - "@nuxt/eslint-config": "^0.2.0", - "@nuxt/fonts": "^0.6.1", - "@nuxt/image": "^1.5.0", + "@nuxt/fonts": "^0.7.0", + "@nuxt/image": "^1.7.0", "@nuxt/ui": "latest", "@nuxt/ui-pro": "file:../../ui-pro2", "@nuxtjs/plausible": "^1.0.0", - "@octokit/rest": "^20.1.0", + "@octokit/rest": "^20.1.1", "@vueuse/nuxt": "^10.9.0", "date-fns": "^3.6.0", - "eslint": "^8.57.0", - "joi": "^17.12.3", - "nuxt": "^3.11.1", - "nuxt-cloudflare-analytics": "^1.0.8", - "nuxt-component-meta": "^0.6.3", + "joi": "^17.13.1", + "nuxt": "^3.11.2", + "nuxt-component-meta": "^0.6.4", "nuxt-og-image": "^2.2.4", "prettier": "^3.2.5", - "typescript": "^5.4.3", + "typescript": "^5.4.5", "ufo": "^1.5.3", "v-calendar": "^3.1.2", "valibot": "^0.30.0", "yup": "^1.4.0", - "zod": "^3.22.4" + "zod": "^3.23.8" } } diff --git a/docs/pages/[...slug].vue b/docs/pages/[...slug].vue index 8635e28b..ae79983d 100644 --- a/docs/pages/[...slug].vue +++ b/docs/pages/[...slug].vue @@ -1,45 +1,8 @@ - - + + diff --git a/docs/pages/examples/[...slug].vue b/docs/pages/examples/[...slug].vue index f4a3b6e8..4b2b6e56 100644 --- a/docs/pages/examples/[...slug].vue +++ b/docs/pages/examples/[...slug].vue @@ -1,11 +1,11 @@ - - + + diff --git a/docs/pages/index.vue b/docs/pages/index.vue index 141f9900..be053c97 100644 --- a/docs/pages/index.vue +++ b/docs/pages/index.vue @@ -1,410 +1,3 @@ - - - + + +