aico-cli 2.1.1 → 2.1.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli/README.md +1 -1
- package/bin/cli/cli.js +9391 -3999
- package/bin/cli/package.json +1 -1
- package/bin/cli/sdk-tools.d.ts +83 -15
- package/dist/chunks/simple-config.mjs +1 -1
- package/package.json +2 -2
- package/templates/cursor.md +72 -15
- package/templates/personality.md +37 -13
- package/templates/skills/antfu/SKILL.md +222 -0
- package/templates/skills/antfu/references/antfu-eslint-config.md +328 -0
- package/templates/skills/antfu/references/app-development.md +60 -0
- package/templates/skills/antfu/references/github-actions.md +68 -0
- package/templates/skills/antfu/references/gitignore.md +29 -0
- package/templates/skills/antfu/references/library-development.md +85 -0
- package/templates/skills/antfu/references/monorepo.md +126 -0
- package/templates/skills/antfu/references/vscode-extensions.md +34 -0
- package/templates/skills/nuxt/GENERATION.md +5 -0
- package/templates/skills/nuxt/SKILL.md +55 -0
- package/templates/skills/nuxt/references/advanced-hooks.md +289 -0
- package/templates/skills/nuxt/references/advanced-layers.md +299 -0
- package/templates/skills/nuxt/references/advanced-module-authoring.md +554 -0
- package/templates/skills/nuxt/references/best-practices-data-fetching.md +357 -0
- package/templates/skills/nuxt/references/best-practices-ssr.md +355 -0
- package/templates/skills/nuxt/references/core-cli.md +263 -0
- package/templates/skills/nuxt/references/core-config.md +162 -0
- package/templates/skills/nuxt/references/core-data-fetching.md +236 -0
- package/templates/skills/nuxt/references/core-deployment.md +224 -0
- package/templates/skills/nuxt/references/core-directory-structure.md +269 -0
- package/templates/skills/nuxt/references/core-modules.md +292 -0
- package/templates/skills/nuxt/references/core-routing.md +226 -0
- package/templates/skills/nuxt/references/features-components-autoimport.md +328 -0
- package/templates/skills/nuxt/references/features-components.md +264 -0
- package/templates/skills/nuxt/references/features-composables.md +276 -0
- package/templates/skills/nuxt/references/features-server.md +265 -0
- package/templates/skills/nuxt/references/features-state.md +194 -0
- package/templates/skills/nuxt/references/rendering-modes.md +237 -0
- package/templates/skills/pinia/GENERATION.md +5 -0
- package/templates/skills/pinia/SKILL.md +59 -0
- package/templates/skills/pinia/references/advanced-hmr.md +61 -0
- package/templates/skills/pinia/references/advanced-nuxt.md +119 -0
- package/templates/skills/pinia/references/advanced-ssr.md +121 -0
- package/templates/skills/pinia/references/best-practices-outside-component.md +115 -0
- package/templates/skills/pinia/references/best-practices-testing.md +212 -0
- package/templates/skills/pinia/references/core-stores.md +389 -0
- package/templates/skills/pinia/references/features-composables.md +114 -0
- package/templates/skills/pinia/references/features-composing-stores.md +134 -0
- package/templates/skills/pinia/references/features-plugins.md +203 -0
- package/templates/skills/pnpm/GENERATION.md +5 -0
- package/templates/skills/pnpm/SKILL.md +42 -0
- package/templates/skills/pnpm/references/best-practices-ci.md +285 -0
- package/templates/skills/pnpm/references/best-practices-migration.md +291 -0
- package/templates/skills/pnpm/references/best-practices-performance.md +284 -0
- package/templates/skills/pnpm/references/core-cli.md +229 -0
- package/templates/skills/pnpm/references/core-config.md +188 -0
- package/templates/skills/pnpm/references/core-store.md +179 -0
- package/templates/skills/pnpm/references/core-workspaces.md +205 -0
- package/templates/skills/pnpm/references/features-aliases.md +168 -0
- package/templates/skills/pnpm/references/features-catalogs.md +159 -0
- package/templates/skills/pnpm/references/features-hooks.md +233 -0
- package/templates/skills/pnpm/references/features-overrides.md +184 -0
- package/templates/skills/pnpm/references/features-patches.md +201 -0
- package/templates/skills/pnpm/references/features-peer-deps.md +250 -0
- package/templates/skills/slidev/LICENSE.md +21 -0
- package/templates/skills/slidev/README.md +61 -0
- package/templates/skills/slidev/SKILL.md +183 -0
- package/templates/skills/slidev/SYNC.md +5 -0
- package/templates/skills/slidev/references/animation-click-marker.md +37 -0
- package/templates/skills/slidev/references/animation-drawing.md +68 -0
- package/templates/skills/slidev/references/animation-rough-marker.md +53 -0
- package/templates/skills/slidev/references/api-slide-hooks.md +37 -0
- package/templates/skills/slidev/references/build-og-image.md +36 -0
- package/templates/skills/slidev/references/build-pdf.md +40 -0
- package/templates/skills/slidev/references/build-remote-assets.md +34 -0
- package/templates/skills/slidev/references/build-seo-meta.md +43 -0
- package/templates/skills/slidev/references/code-groups.md +64 -0
- package/templates/skills/slidev/references/code-import-snippet.md +55 -0
- package/templates/skills/slidev/references/code-line-highlighting.md +50 -0
- package/templates/skills/slidev/references/code-line-numbers.md +46 -0
- package/templates/skills/slidev/references/code-magic-move.md +57 -0
- package/templates/skills/slidev/references/code-max-height.md +37 -0
- package/templates/skills/slidev/references/code-twoslash.md +42 -0
- package/templates/skills/slidev/references/core-animations.md +196 -0
- package/templates/skills/slidev/references/core-cli.md +140 -0
- package/templates/skills/slidev/references/core-components.md +197 -0
- package/templates/skills/slidev/references/core-exporting.md +148 -0
- package/templates/skills/slidev/references/core-frontmatter.md +195 -0
- package/templates/skills/slidev/references/core-global-context.md +155 -0
- package/templates/skills/slidev/references/core-headmatter.md +188 -0
- package/templates/skills/slidev/references/core-hosting.md +152 -0
- package/templates/skills/slidev/references/core-layouts.md +286 -0
- package/templates/skills/slidev/references/core-syntax.md +155 -0
- package/templates/skills/slidev/references/diagram-latex.md +55 -0
- package/templates/skills/slidev/references/diagram-mermaid.md +44 -0
- package/templates/skills/slidev/references/diagram-plantuml.md +45 -0
- package/templates/skills/slidev/references/editor-monaco-run.md +44 -0
- package/templates/skills/slidev/references/editor-monaco-write.md +24 -0
- package/templates/skills/slidev/references/editor-monaco.md +50 -0
- package/templates/skills/slidev/references/editor-prettier.md +40 -0
- package/templates/skills/slidev/references/editor-side.md +23 -0
- package/templates/skills/slidev/references/editor-vscode.md +55 -0
- package/templates/skills/slidev/references/layout-canvas-size.md +25 -0
- package/templates/skills/slidev/references/layout-draggable.md +57 -0
- package/templates/skills/slidev/references/layout-global-layers.md +50 -0
- package/templates/skills/slidev/references/layout-slots.md +75 -0
- package/templates/skills/slidev/references/layout-transform.md +33 -0
- package/templates/skills/slidev/references/layout-zoom.md +39 -0
- package/templates/skills/slidev/references/presenter-notes-ruby.md +35 -0
- package/templates/skills/slidev/references/presenter-recording.md +30 -0
- package/templates/skills/slidev/references/presenter-remote.md +40 -0
- package/templates/skills/slidev/references/presenter-timer.md +34 -0
- package/templates/skills/slidev/references/style-direction.md +34 -0
- package/templates/skills/slidev/references/style-icons.md +46 -0
- package/templates/skills/slidev/references/style-scoped.md +50 -0
- package/templates/skills/slidev/references/syntax-block-frontmatter.md +39 -0
- package/templates/skills/slidev/references/syntax-frontmatter-merging.md +49 -0
- package/templates/skills/slidev/references/syntax-importing-slides.md +60 -0
- package/templates/skills/slidev/references/syntax-mdc.md +51 -0
- package/templates/skills/slidev/references/tool-eject-theme.md +27 -0
- package/templates/skills/tech-whitepaper/SKILL.md +102 -15
- package/templates/skills/tsdown/GENERATION.md +5 -0
- package/templates/skills/tsdown/SKILL.md +59 -0
- package/templates/skills/tsdown/references/advanced-hooks.md +87 -0
- package/templates/skills/tsdown/references/advanced-plugins.md +97 -0
- package/templates/skills/tsdown/references/advanced-programmatic.md +78 -0
- package/templates/skills/tsdown/references/advanced-rolldown-options.md +114 -0
- package/templates/skills/tsdown/references/core-cli.md +116 -0
- package/templates/skills/tsdown/references/core-config.md +86 -0
- package/templates/skills/tsdown/references/core-entry.md +74 -0
- package/templates/skills/tsdown/references/features-optimization.md +83 -0
- package/templates/skills/tsdown/references/features-shims.md +92 -0
- package/templates/skills/tsdown/references/features-unbundle.md +63 -0
- package/templates/skills/tsdown/references/features-watch.md +60 -0
- package/templates/skills/tsdown/references/options-dependencies.md +88 -0
- package/templates/skills/tsdown/references/options-dts.md +104 -0
- package/templates/skills/tsdown/references/options-output.md +124 -0
- package/templates/skills/tsdown/references/options-package-exports.md +114 -0
- package/templates/skills/tsdown/references/recipes-frameworks.md +109 -0
- package/templates/skills/tsdown/references/recipes-migration.md +84 -0
- package/templates/skills/turborepo/LICENSE.md +7 -0
- package/templates/skills/turborepo/SKILL.md +914 -0
- package/templates/skills/turborepo/SYNC.md +5 -0
- package/templates/skills/turborepo/command/turborepo.md +70 -0
- package/templates/skills/turborepo/references/best-practices/README.md +241 -0
- package/templates/skills/turborepo/references/best-practices/dependencies.md +246 -0
- package/templates/skills/turborepo/references/best-practices/packages.md +335 -0
- package/templates/skills/turborepo/references/best-practices/structure.md +269 -0
- package/templates/skills/turborepo/references/boundaries/README.md +126 -0
- package/templates/skills/turborepo/references/caching/README.md +107 -0
- package/templates/skills/turborepo/references/caching/gotchas.md +169 -0
- package/templates/skills/turborepo/references/caching/remote-cache.md +127 -0
- package/templates/skills/turborepo/references/ci/README.md +79 -0
- package/templates/skills/turborepo/references/ci/github-actions.md +162 -0
- package/templates/skills/turborepo/references/ci/patterns.md +145 -0
- package/templates/skills/turborepo/references/ci/vercel.md +103 -0
- package/templates/skills/turborepo/references/cli/README.md +100 -0
- package/templates/skills/turborepo/references/cli/commands.md +297 -0
- package/templates/skills/turborepo/references/configuration/README.md +211 -0
- package/templates/skills/turborepo/references/configuration/global-options.md +195 -0
- package/templates/skills/turborepo/references/configuration/gotchas.md +348 -0
- package/templates/skills/turborepo/references/configuration/tasks.md +285 -0
- package/templates/skills/turborepo/references/environment/README.md +96 -0
- package/templates/skills/turborepo/references/environment/gotchas.md +145 -0
- package/templates/skills/turborepo/references/environment/modes.md +101 -0
- package/templates/skills/turborepo/references/filtering/README.md +148 -0
- package/templates/skills/turborepo/references/filtering/patterns.md +152 -0
- package/templates/skills/turborepo/references/watch/README.md +99 -0
- package/templates/skills/unocss/GENERATION.md +5 -0
- package/templates/skills/unocss/SKILL.md +64 -0
- package/templates/skills/unocss/references/core-config.md +187 -0
- package/templates/skills/unocss/references/core-extracting.md +137 -0
- package/templates/skills/unocss/references/core-layers.md +104 -0
- package/templates/skills/unocss/references/core-rules.md +166 -0
- package/templates/skills/unocss/references/core-safelist.md +105 -0
- package/templates/skills/unocss/references/core-shortcuts.md +89 -0
- package/templates/skills/unocss/references/core-theme.md +172 -0
- package/templates/skills/unocss/references/core-variants.md +175 -0
- package/templates/skills/unocss/references/integrations-nuxt.md +199 -0
- package/templates/skills/unocss/references/integrations-vite.md +283 -0
- package/templates/skills/unocss/references/preset-attributify.md +142 -0
- package/templates/skills/unocss/references/preset-icons.md +184 -0
- package/templates/skills/unocss/references/preset-mini.md +158 -0
- package/templates/skills/unocss/references/preset-rem-to-px.md +97 -0
- package/templates/skills/unocss/references/preset-tagify.md +134 -0
- package/templates/skills/unocss/references/preset-typography.md +95 -0
- package/templates/skills/unocss/references/preset-web-fonts.md +91 -0
- package/templates/skills/unocss/references/preset-wind3.md +194 -0
- package/templates/skills/unocss/references/preset-wind4.md +247 -0
- package/templates/skills/unocss/references/transformer-attributify-jsx.md +156 -0
- package/templates/skills/unocss/references/transformer-compile-class.md +128 -0
- package/templates/skills/unocss/references/transformer-directives.md +157 -0
- package/templates/skills/unocss/references/transformer-variant-group.md +97 -0
- package/templates/skills/vite/GENERATION.md +5 -0
- package/templates/skills/vite/SKILL.md +50 -0
- package/templates/skills/vite/references/advanced-api.md +218 -0
- package/templates/skills/vite/references/advanced-backend.md +164 -0
- package/templates/skills/vite/references/advanced-performance.md +168 -0
- package/templates/skills/vite/references/advanced-plugin-api.md +258 -0
- package/templates/skills/vite/references/build-library.md +172 -0
- package/templates/skills/vite/references/build-production.md +220 -0
- package/templates/skills/vite/references/build-ssr.md +194 -0
- package/templates/skills/vite/references/core-cli.md +137 -0
- package/templates/skills/vite/references/core-config.md +176 -0
- package/templates/skills/vite/references/core-features.md +170 -0
- package/templates/skills/vite/references/core-plugins.md +154 -0
- package/templates/skills/vite/references/features-assets.md +138 -0
- package/templates/skills/vite/references/features-css.md +215 -0
- package/templates/skills/vite/references/features-dep-bundling.md +148 -0
- package/templates/skills/vite/references/features-env.md +161 -0
- package/templates/skills/vite/references/features-glob-import.md +161 -0
- package/templates/skills/vite/references/features-hmr.md +200 -0
- package/templates/skills/vite/references/features-workers.md +115 -0
- package/templates/skills/vitepress/GENERATION.md +5 -0
- package/templates/skills/vitepress/SKILL.md +65 -0
- package/templates/skills/vitepress/references/advanced-i18n.md +299 -0
- package/templates/skills/vitepress/references/advanced-ssr.md +228 -0
- package/templates/skills/vitepress/references/core-cli.md +119 -0
- package/templates/skills/vitepress/references/core-config.md +189 -0
- package/templates/skills/vitepress/references/core-markdown.md +277 -0
- package/templates/skills/vitepress/references/core-routing.md +169 -0
- package/templates/skills/vitepress/references/features-code-blocks.md +243 -0
- package/templates/skills/vitepress/references/features-data-loading.md +220 -0
- package/templates/skills/vitepress/references/features-dynamic-routes.md +235 -0
- package/templates/skills/vitepress/references/features-vue.md +224 -0
- package/templates/skills/vitepress/references/recipes-deploy.md +240 -0
- package/templates/skills/vitepress/references/theme-config.md +315 -0
- package/templates/skills/vitepress/references/theme-custom.md +269 -0
- package/templates/skills/vitepress/references/theme-customization.md +290 -0
- package/templates/skills/vitest/GENERATION.md +5 -0
- package/templates/skills/vitest/SKILL.md +52 -0
- package/templates/skills/vitest/references/advanced-environments.md +264 -0
- package/templates/skills/vitest/references/advanced-projects.md +300 -0
- package/templates/skills/vitest/references/advanced-type-testing.md +237 -0
- package/templates/skills/vitest/references/advanced-vi.md +249 -0
- package/templates/skills/vitest/references/core-cli.md +166 -0
- package/templates/skills/vitest/references/core-config.md +174 -0
- package/templates/skills/vitest/references/core-describe.md +193 -0
- package/templates/skills/vitest/references/core-expect.md +219 -0
- package/templates/skills/vitest/references/core-hooks.md +244 -0
- package/templates/skills/vitest/references/core-test-api.md +233 -0
- package/templates/skills/vitest/references/features-concurrency.md +250 -0
- package/templates/skills/vitest/references/features-context.md +238 -0
- package/templates/skills/vitest/references/features-coverage.md +207 -0
- package/templates/skills/vitest/references/features-filtering.md +211 -0
- package/templates/skills/vitest/references/features-mocking.md +265 -0
- package/templates/skills/vitest/references/features-snapshots.md +207 -0
- package/templates/skills/vue/GENERATION.md +5 -0
- package/templates/skills/vue/SKILL.md +63 -0
- package/templates/skills/vue/references/advanced-async-suspense.md +246 -0
- package/templates/skills/vue/references/advanced-provide-inject.md +174 -0
- package/templates/skills/vue/references/components-emits.md +139 -0
- package/templates/skills/vue/references/components-lifecycle.md +192 -0
- package/templates/skills/vue/references/components-props.md +211 -0
- package/templates/skills/vue/references/components-slots.md +201 -0
- package/templates/skills/vue/references/components-v-model.md +183 -0
- package/templates/skills/vue/references/core-reactivity.md +289 -0
- package/templates/skills/vue/references/features-composables.md +262 -0
- package/templates/skills/vue/references/features-directives.md +224 -0
- package/templates/skills/vue/references/features-script-setup.md +247 -0
- package/templates/skills/vue/references/features-template-refs.md +212 -0
- package/templates/skills/vue/references/features-typescript.md +274 -0
- package/templates/skills/vue-best-practices/LICENSE.md +21 -0
- package/templates/skills/vue-best-practices/SKILL.md +38 -0
- package/templates/skills/vue-best-practices/SYNC.md +5 -0
- package/templates/skills/vue-best-practices/rules/codeactions-save-performance.md +79 -0
- package/templates/skills/vue-best-practices/rules/data-attributes-config.md +74 -0
- package/templates/skills/vue-best-practices/rules/deep-watch-numeric.md +97 -0
- package/templates/skills/vue-best-practices/rules/define-model-update-event.md +79 -0
- package/templates/skills/vue-best-practices/rules/duplicate-plugin-detection.md +102 -0
- package/templates/skills/vue-best-practices/rules/extract-component-props.md +57 -0
- package/templates/skills/vue-best-practices/rules/fallthrough-attributes.md +63 -0
- package/templates/skills/vue-best-practices/rules/hmr-vue-ssr.md +124 -0
- package/templates/skills/vue-best-practices/rules/module-resolution-bundler.md +81 -0
- package/templates/skills/vue-best-practices/rules/pinia-store-mocking.md +159 -0
- package/templates/skills/vue-best-practices/rules/script-setup-jsdoc.md +85 -0
- package/templates/skills/vue-best-practices/rules/strict-css-modules.md +68 -0
- package/templates/skills/vue-best-practices/rules/volar-3-breaking-changes.md +65 -0
- package/templates/skills/vue-best-practices/rules/vue-directive-comments.md +73 -0
- package/templates/skills/vue-best-practices/rules/vue-router-typed-params.md +81 -0
- package/templates/skills/vue-best-practices/rules/vue-tsc-strict-templates.md +69 -0
- package/templates/skills/vue-best-practices/rules/with-defaults-union-types.md +102 -0
- package/templates/skills/vueuse-functions/LICENSE.md +21 -0
- package/templates/skills/vueuse-functions/SKILL.md +418 -0
- package/templates/skills/vueuse-functions/SYNC.md +5 -0
- package/templates/skills/vueuse-functions/references/computedAsync.md +159 -0
- package/templates/skills/vueuse-functions/references/computedEager.md +62 -0
- package/templates/skills/vueuse-functions/references/computedInject.md +86 -0
- package/templates/skills/vueuse-functions/references/computedWithControl.md +100 -0
- package/templates/skills/vueuse-functions/references/createEventHook.md +86 -0
- package/templates/skills/vueuse-functions/references/createGenericProjection.md +25 -0
- package/templates/skills/vueuse-functions/references/createGlobalState.md +95 -0
- package/templates/skills/vueuse-functions/references/createInjectionState.md +215 -0
- package/templates/skills/vueuse-functions/references/createProjection.md +31 -0
- package/templates/skills/vueuse-functions/references/createRef.md +54 -0
- package/templates/skills/vueuse-functions/references/createReusableTemplate.md +357 -0
- package/templates/skills/vueuse-functions/references/createSharedComposable.md +42 -0
- package/templates/skills/vueuse-functions/references/createTemplatePromise.md +259 -0
- package/templates/skills/vueuse-functions/references/createUnrefFn.md +51 -0
- package/templates/skills/vueuse-functions/references/extendRef.md +76 -0
- package/templates/skills/vueuse-functions/references/from.md +48 -0
- package/templates/skills/vueuse-functions/references/get.md +30 -0
- package/templates/skills/vueuse-functions/references/injectLocal.md +35 -0
- package/templates/skills/vueuse-functions/references/isDefined.md +31 -0
- package/templates/skills/vueuse-functions/references/logicAnd.md +40 -0
- package/templates/skills/vueuse-functions/references/logicNot.md +36 -0
- package/templates/skills/vueuse-functions/references/logicOr.md +40 -0
- package/templates/skills/vueuse-functions/references/makeDestructurable.md +41 -0
- package/templates/skills/vueuse-functions/references/onClickOutside.md +187 -0
- package/templates/skills/vueuse-functions/references/onElementRemoval.md +64 -0
- package/templates/skills/vueuse-functions/references/onKeyStroke.md +176 -0
- package/templates/skills/vueuse-functions/references/onLongPress.md +170 -0
- package/templates/skills/vueuse-functions/references/onStartTyping.md +43 -0
- package/templates/skills/vueuse-functions/references/provideLocal.md +37 -0
- package/templates/skills/vueuse-functions/references/reactify.md +144 -0
- package/templates/skills/vueuse-functions/references/reactifyObject.md +61 -0
- package/templates/skills/vueuse-functions/references/reactiveComputed.md +34 -0
- package/templates/skills/vueuse-functions/references/reactiveOmit.md +86 -0
- package/templates/skills/vueuse-functions/references/reactivePick.md +106 -0
- package/templates/skills/vueuse-functions/references/refAutoReset.md +44 -0
- package/templates/skills/vueuse-functions/references/refDebounced.md +81 -0
- package/templates/skills/vueuse-functions/references/refDefault.md +36 -0
- package/templates/skills/vueuse-functions/references/refManualReset.md +44 -0
- package/templates/skills/vueuse-functions/references/refThrottled.md +99 -0
- package/templates/skills/vueuse-functions/references/refWithControl.md +146 -0
- package/templates/skills/vueuse-functions/references/set.md +30 -0
- package/templates/skills/vueuse-functions/references/syncRef.md +195 -0
- package/templates/skills/vueuse-functions/references/syncRefs.md +128 -0
- package/templates/skills/vueuse-functions/references/templateRef.md +86 -0
- package/templates/skills/vueuse-functions/references/toObserver.md +38 -0
- package/templates/skills/vueuse-functions/references/toReactive.md +41 -0
- package/templates/skills/vueuse-functions/references/toRef.md +75 -0
- package/templates/skills/vueuse-functions/references/toRefs.md +81 -0
- package/templates/skills/vueuse-functions/references/tryOnBeforeMount.md +34 -0
- package/templates/skills/vueuse-functions/references/tryOnBeforeUnmount.md +32 -0
- package/templates/skills/vueuse-functions/references/tryOnMounted.md +34 -0
- package/templates/skills/vueuse-functions/references/tryOnScopeDispose.md +31 -0
- package/templates/skills/vueuse-functions/references/tryOnUnmounted.md +32 -0
- package/templates/skills/vueuse-functions/references/unrefElement.md +54 -0
- package/templates/skills/vueuse-functions/references/until.md +165 -0
- package/templates/skills/vueuse-functions/references/useAbs.md +31 -0
- package/templates/skills/vueuse-functions/references/useActiveElement.md +65 -0
- package/templates/skills/vueuse-functions/references/useAnimate.md +140 -0
- package/templates/skills/vueuse-functions/references/useArrayDifference.md +84 -0
- package/templates/skills/vueuse-functions/references/useArrayEvery.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayFilter.md +63 -0
- package/templates/skills/vueuse-functions/references/useArrayFind.md +50 -0
- package/templates/skills/vueuse-functions/references/useArrayFindIndex.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayFindLast.md +52 -0
- package/templates/skills/vueuse-functions/references/useArrayIncludes.md +63 -0
- package/templates/skills/vueuse-functions/references/useArrayJoin.md +74 -0
- package/templates/skills/vueuse-functions/references/useArrayMap.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayReduce.md +81 -0
- package/templates/skills/vueuse-functions/references/useArraySome.md +59 -0
- package/templates/skills/vueuse-functions/references/useArrayUnique.md +76 -0
- package/templates/skills/vueuse-functions/references/useAsyncQueue.md +87 -0
- package/templates/skills/vueuse-functions/references/useAsyncState.md +140 -0
- package/templates/skills/vueuse-functions/references/useAsyncValidator.md +70 -0
- package/templates/skills/vueuse-functions/references/useAuth.md +114 -0
- package/templates/skills/vueuse-functions/references/useAverage.md +36 -0
- package/templates/skills/vueuse-functions/references/useAxios.md +292 -0
- package/templates/skills/vueuse-functions/references/useBase64.md +88 -0
- package/templates/skills/vueuse-functions/references/useBattery.md +67 -0
- package/templates/skills/vueuse-functions/references/useBluetooth.md +161 -0
- package/templates/skills/vueuse-functions/references/useBreakpoints.md +128 -0
- package/templates/skills/vueuse-functions/references/useBroadcastChannel.md +74 -0
- package/templates/skills/vueuse-functions/references/useBrowserLocation.md +83 -0
- package/templates/skills/vueuse-functions/references/useCached.md +53 -0
- package/templates/skills/vueuse-functions/references/useCeil.md +31 -0
- package/templates/skills/vueuse-functions/references/useChangeCase.md +79 -0
- package/templates/skills/vueuse-functions/references/useClamp.md +51 -0
- package/templates/skills/vueuse-functions/references/useClipboard.md +99 -0
- package/templates/skills/vueuse-functions/references/useClipboardItems.md +93 -0
- package/templates/skills/vueuse-functions/references/useCloned.md +91 -0
- package/templates/skills/vueuse-functions/references/useColorMode.md +171 -0
- package/templates/skills/vueuse-functions/references/useConfirmDialog.md +159 -0
- package/templates/skills/vueuse-functions/references/useCookies.md +162 -0
- package/templates/skills/vueuse-functions/references/useCountdown.md +102 -0
- package/templates/skills/vueuse-functions/references/useCounter.md +86 -0
- package/templates/skills/vueuse-functions/references/useCssVar.md +50 -0
- package/templates/skills/vueuse-functions/references/useCurrentElement.md +61 -0
- package/templates/skills/vueuse-functions/references/useCycleList.md +75 -0
- package/templates/skills/vueuse-functions/references/useDark.md +142 -0
- package/templates/skills/vueuse-functions/references/useDateFormat.md +145 -0
- package/templates/skills/vueuse-functions/references/useDebounceFn.md +100 -0
- package/templates/skills/vueuse-functions/references/useDebouncedRefHistory.md +40 -0
- package/templates/skills/vueuse-functions/references/useDeviceMotion.md +87 -0
- package/templates/skills/vueuse-functions/references/useDeviceOrientation.md +62 -0
- package/templates/skills/vueuse-functions/references/useDevicePixelRatio.md +44 -0
- package/templates/skills/vueuse-functions/references/useDevicesList.md +90 -0
- package/templates/skills/vueuse-functions/references/useDisplayMedia.md +71 -0
- package/templates/skills/vueuse-functions/references/useDocumentVisibility.md +45 -0
- package/templates/skills/vueuse-functions/references/useDraggable.md +210 -0
- package/templates/skills/vueuse-functions/references/useDrauu.md +65 -0
- package/templates/skills/vueuse-functions/references/useDropZone.md +83 -0
- package/templates/skills/vueuse-functions/references/useElementBounding.md +131 -0
- package/templates/skills/vueuse-functions/references/useElementByPoint.md +45 -0
- package/templates/skills/vueuse-functions/references/useElementHover.md +79 -0
- package/templates/skills/vueuse-functions/references/useElementSize.md +78 -0
- package/templates/skills/vueuse-functions/references/useElementVisibility.md +126 -0
- package/templates/skills/vueuse-functions/references/useEventBus.md +101 -0
- package/templates/skills/vueuse-functions/references/useEventListener.md +184 -0
- package/templates/skills/vueuse-functions/references/useEventSource.md +204 -0
- package/templates/skills/vueuse-functions/references/useExtractedObservable.md +185 -0
- package/templates/skills/vueuse-functions/references/useEyeDropper.md +71 -0
- package/templates/skills/vueuse-functions/references/useFavicon.md +67 -0
- package/templates/skills/vueuse-functions/references/useFetch.md +546 -0
- package/templates/skills/vueuse-functions/references/useFileDialog.md +91 -0
- package/templates/skills/vueuse-functions/references/useFileSystemAccess.md +162 -0
- package/templates/skills/vueuse-functions/references/useFirestore.md +104 -0
- package/templates/skills/vueuse-functions/references/useFloor.md +31 -0
- package/templates/skills/vueuse-functions/references/useFocus.md +99 -0
- package/templates/skills/vueuse-functions/references/useFocusTrap.md +245 -0
- package/templates/skills/vueuse-functions/references/useFocusWithin.md +57 -0
- package/templates/skills/vueuse-functions/references/useFps.md +28 -0
- package/templates/skills/vueuse-functions/references/useFullscreen.md +75 -0
- package/templates/skills/vueuse-functions/references/useFuse.md +107 -0
- package/templates/skills/vueuse-functions/references/useGamepad.md +223 -0
- package/templates/skills/vueuse-functions/references/useGeolocation.md +86 -0
- package/templates/skills/vueuse-functions/references/useIDBKeyval.md +93 -0
- package/templates/skills/vueuse-functions/references/useIdle.md +89 -0
- package/templates/skills/vueuse-functions/references/useImage.md +86 -0
- package/templates/skills/vueuse-functions/references/useInfiniteScroll.md +157 -0
- package/templates/skills/vueuse-functions/references/useIntersectionObserver.md +118 -0
- package/templates/skills/vueuse-functions/references/useInterval.md +69 -0
- package/templates/skills/vueuse-functions/references/useIntervalFn.md +50 -0
- package/templates/skills/vueuse-functions/references/useIpcRenderer.md +118 -0
- package/templates/skills/vueuse-functions/references/useIpcRendererInvoke.md +58 -0
- package/templates/skills/vueuse-functions/references/useIpcRendererOn.md +52 -0
- package/templates/skills/vueuse-functions/references/useJwt.md +57 -0
- package/templates/skills/vueuse-functions/references/useKeyModifier.md +87 -0
- package/templates/skills/vueuse-functions/references/useLastChanged.md +63 -0
- package/templates/skills/vueuse-functions/references/useLocalStorage.md +41 -0
- package/templates/skills/vueuse-functions/references/useMagicKeys.md +217 -0
- package/templates/skills/vueuse-functions/references/useManualRefHistory.md +204 -0
- package/templates/skills/vueuse-functions/references/useMath.md +47 -0
- package/templates/skills/vueuse-functions/references/useMax.md +36 -0
- package/templates/skills/vueuse-functions/references/useMediaControls.md +571 -0
- package/templates/skills/vueuse-functions/references/useMediaQuery.md +53 -0
- package/templates/skills/vueuse-functions/references/useMemoize.md +175 -0
- package/templates/skills/vueuse-functions/references/useMemory.md +56 -0
- package/templates/skills/vueuse-functions/references/useMin.md +36 -0
- package/templates/skills/vueuse-functions/references/useMounted.md +38 -0
- package/templates/skills/vueuse-functions/references/useMouse.md +114 -0
- package/templates/skills/vueuse-functions/references/useMouseInElement.md +123 -0
- package/templates/skills/vueuse-functions/references/useMousePressed.md +112 -0
- package/templates/skills/vueuse-functions/references/useMutationObserver.md +62 -0
- package/templates/skills/vueuse-functions/references/useNProgress.md +78 -0
- package/templates/skills/vueuse-functions/references/useNavigatorLanguage.md +57 -0
- package/templates/skills/vueuse-functions/references/useNetwork.md +106 -0
- package/templates/skills/vueuse-functions/references/useNow.md +75 -0
- package/templates/skills/vueuse-functions/references/useObjectUrl.md +55 -0
- package/templates/skills/vueuse-functions/references/useObservable.md +67 -0
- package/templates/skills/vueuse-functions/references/useOffsetPagination.md +199 -0
- package/templates/skills/vueuse-functions/references/useOnline.md +41 -0
- package/templates/skills/vueuse-functions/references/usePageLeave.md +42 -0
- package/templates/skills/vueuse-functions/references/useParallax.md +58 -0
- package/templates/skills/vueuse-functions/references/useParentElement.md +54 -0
- package/templates/skills/vueuse-functions/references/usePerformanceObserver.md +48 -0
- package/templates/skills/vueuse-functions/references/usePermission.md +78 -0
- package/templates/skills/vueuse-functions/references/usePointer.md +89 -0
- package/templates/skills/vueuse-functions/references/usePointerLock.md +60 -0
- package/templates/skills/vueuse-functions/references/usePointerSwipe.md +80 -0
- package/templates/skills/vueuse-functions/references/usePrecision.md +49 -0
- package/templates/skills/vueuse-functions/references/usePreferredColorScheme.md +42 -0
- package/templates/skills/vueuse-functions/references/usePreferredContrast.md +42 -0
- package/templates/skills/vueuse-functions/references/usePreferredDark.md +41 -0
- package/templates/skills/vueuse-functions/references/usePreferredLanguages.md +41 -0
- package/templates/skills/vueuse-functions/references/usePreferredReducedMotion.md +42 -0
- package/templates/skills/vueuse-functions/references/usePreferredReducedTransparency.md +42 -0
- package/templates/skills/vueuse-functions/references/usePrevious.md +40 -0
- package/templates/skills/vueuse-functions/references/useProjection.md +38 -0
- package/templates/skills/vueuse-functions/references/useQRCode.md +53 -0
- package/templates/skills/vueuse-functions/references/useRTDB.md +70 -0
- package/templates/skills/vueuse-functions/references/useRafFn.md +68 -0
- package/templates/skills/vueuse-functions/references/useRefHistory.md +292 -0
- package/templates/skills/vueuse-functions/references/useResizeObserver.md +110 -0
- package/templates/skills/vueuse-functions/references/useRound.md +31 -0
- package/templates/skills/vueuse-functions/references/useRouteHash.md +27 -0
- package/templates/skills/vueuse-functions/references/useRouteParams.md +38 -0
- package/templates/skills/vueuse-functions/references/useRouteQuery.md +38 -0
- package/templates/skills/vueuse-functions/references/useSSRWidth.md +47 -0
- package/templates/skills/vueuse-functions/references/useScreenOrientation.md +96 -0
- package/templates/skills/vueuse-functions/references/useScreenSafeArea.md +60 -0
- package/templates/skills/vueuse-functions/references/useScriptTag.md +116 -0
- package/templates/skills/vueuse-functions/references/useScroll.md +238 -0
- package/templates/skills/vueuse-functions/references/useScrollLock.md +66 -0
- package/templates/skills/vueuse-functions/references/useSessionStorage.md +41 -0
- package/templates/skills/vueuse-functions/references/useShare.md +68 -0
- package/templates/skills/vueuse-functions/references/useSortable.md +177 -0
- package/templates/skills/vueuse-functions/references/useSorted.md +90 -0
- package/templates/skills/vueuse-functions/references/useSpeechRecognition.md +94 -0
- package/templates/skills/vueuse-functions/references/useSpeechSynthesis.md +105 -0
- package/templates/skills/vueuse-functions/references/useStepper.md +137 -0
- package/templates/skills/vueuse-functions/references/useStorage.md +219 -0
- package/templates/skills/vueuse-functions/references/useStorageAsync.md +134 -0
- package/templates/skills/vueuse-functions/references/useStyleTag.md +131 -0
- package/templates/skills/vueuse-functions/references/useSubject.md +52 -0
- package/templates/skills/vueuse-functions/references/useSubscription.md +33 -0
- package/templates/skills/vueuse-functions/references/useSum.md +36 -0
- package/templates/skills/vueuse-functions/references/useSupported.md +29 -0
- package/templates/skills/vueuse-functions/references/useSwipe.md +75 -0
- package/templates/skills/vueuse-functions/references/useTemplateRefsList.md +37 -0
- package/templates/skills/vueuse-functions/references/useTextDirection.md +75 -0
- package/templates/skills/vueuse-functions/references/useTextSelection.md +40 -0
- package/templates/skills/vueuse-functions/references/useTextareaAutosize.md +97 -0
- package/templates/skills/vueuse-functions/references/useThrottleFn.md +57 -0
- package/templates/skills/vueuse-functions/references/useThrottledRefHistory.md +47 -0
- package/templates/skills/vueuse-functions/references/useTimeAgo.md +152 -0
- package/templates/skills/vueuse-functions/references/useTimeAgoIntl.md +116 -0
- package/templates/skills/vueuse-functions/references/useTimeout.md +75 -0
- package/templates/skills/vueuse-functions/references/useTimeoutFn.md +51 -0
- package/templates/skills/vueuse-functions/references/useTimeoutPoll.md +47 -0
- package/templates/skills/vueuse-functions/references/useTimestamp.md +85 -0
- package/templates/skills/vueuse-functions/references/useTitle.md +113 -0
- package/templates/skills/vueuse-functions/references/useToNumber.md +54 -0
- package/templates/skills/vueuse-functions/references/useToString.md +34 -0
- package/templates/skills/vueuse-functions/references/useToggle.md +56 -0
- package/templates/skills/vueuse-functions/references/useTransition.md +265 -0
- package/templates/skills/vueuse-functions/references/useTrunc.md +33 -0
- package/templates/skills/vueuse-functions/references/useUrlSearchParams.md +121 -0
- package/templates/skills/vueuse-functions/references/useUserMedia.md +1138 -0
- package/templates/skills/vueuse-functions/references/useVModel.md +116 -0
- package/templates/skills/vueuse-functions/references/useVModels.md +67 -0
- package/templates/skills/vueuse-functions/references/useVibrate.md +83 -0
- package/templates/skills/vueuse-functions/references/useVirtualList.md +184 -0
- package/templates/skills/vueuse-functions/references/useWakeLock.md +50 -0
- package/templates/skills/vueuse-functions/references/useWebNotification.md +177 -0
- package/templates/skills/vueuse-functions/references/useWebSocket.md +268 -0
- package/templates/skills/vueuse-functions/references/useWebWorker.md +60 -0
- package/templates/skills/vueuse-functions/references/useWebWorkerFn.md +102 -0
- package/templates/skills/vueuse-functions/references/useWindowFocus.md +46 -0
- package/templates/skills/vueuse-functions/references/useWindowScroll.md +62 -0
- package/templates/skills/vueuse-functions/references/useWindowSize.md +76 -0
- package/templates/skills/vueuse-functions/references/useZoomFactor.md +53 -0
- package/templates/skills/vueuse-functions/references/useZoomLevel.md +53 -0
- package/templates/skills/vueuse-functions/references/watchArray.md +53 -0
- package/templates/skills/vueuse-functions/references/watchAtMost.md +54 -0
- package/templates/skills/vueuse-functions/references/watchDebounced.md +72 -0
- package/templates/skills/vueuse-functions/references/watchDeep.md +54 -0
- package/templates/skills/vueuse-functions/references/watchExtractedObservable.md +167 -0
- package/templates/skills/vueuse-functions/references/watchIgnorable.md +120 -0
- package/templates/skills/vueuse-functions/references/watchImmediate.md +44 -0
- package/templates/skills/vueuse-functions/references/watchOnce.md +41 -0
- package/templates/skills/vueuse-functions/references/watchPausable.md +86 -0
- package/templates/skills/vueuse-functions/references/watchThrottled.md +73 -0
- package/templates/skills/vueuse-functions/references/watchTriggerable.md +97 -0
- package/templates/skills/vueuse-functions/references/watchWithFilter.md +55 -0
- package/templates/skills/vueuse-functions/references/whenever.md +100 -0
- package/templates/skills/web-design-guidelines/SKILL.md +39 -0
- package/templates/skills/web-design-guidelines/SYNC.md +5 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: features-workers
|
|
3
|
+
description: Web Worker support in Vite
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Web Workers
|
|
7
|
+
|
|
8
|
+
## Constructor Syntax (Recommended)
|
|
9
|
+
|
|
10
|
+
Standard Web Worker creation:
|
|
11
|
+
|
|
12
|
+
```ts
|
|
13
|
+
const worker = new Worker(new URL('./worker.js', import.meta.url))
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Module worker:
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
const worker = new Worker(new URL('./worker.js', import.meta.url), {
|
|
20
|
+
type: 'module'
|
|
21
|
+
})
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Shared Worker:
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
const sharedWorker = new SharedWorker(
|
|
28
|
+
new URL('./shared-worker.js', import.meta.url)
|
|
29
|
+
)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Note:** The `new URL()` must be used directly inside `new Worker()` for detection.
|
|
33
|
+
|
|
34
|
+
## Query Suffix Syntax
|
|
35
|
+
|
|
36
|
+
Import with `?worker` suffix:
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
import MyWorker from './worker?worker'
|
|
40
|
+
|
|
41
|
+
const worker = new MyWorker()
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Shared worker:
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import MySharedWorker from './worker?sharedworker'
|
|
48
|
+
|
|
49
|
+
const worker = new MySharedWorker()
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Inline Worker
|
|
53
|
+
|
|
54
|
+
Inline as base64 string (no separate chunk):
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import MyWorker from './worker?worker&inline'
|
|
58
|
+
|
|
59
|
+
const worker = new MyWorker()
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Worker URL Only
|
|
63
|
+
|
|
64
|
+
Get URL instead of constructor:
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
import workerUrl from './worker?worker&url'
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Worker Script
|
|
71
|
+
|
|
72
|
+
Workers can use ESM `import` statements:
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
// worker.js
|
|
76
|
+
import { heavyComputation } from './utils'
|
|
77
|
+
|
|
78
|
+
self.onmessage = (e) => {
|
|
79
|
+
const result = heavyComputation(e.data)
|
|
80
|
+
self.postMessage(result)
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Worker Options
|
|
85
|
+
|
|
86
|
+
Configure worker bundling:
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
// vite.config.ts
|
|
90
|
+
export default defineConfig({
|
|
91
|
+
worker: {
|
|
92
|
+
format: 'es', // or 'iife'
|
|
93
|
+
plugins: () => [/* worker-specific plugins */],
|
|
94
|
+
rollupOptions: {
|
|
95
|
+
// Rollup options for worker bundle
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
})
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## WebAssembly in Workers
|
|
102
|
+
|
|
103
|
+
```ts
|
|
104
|
+
// worker.js
|
|
105
|
+
import init from './module.wasm?init'
|
|
106
|
+
|
|
107
|
+
init().then((instance) => {
|
|
108
|
+
instance.exports.compute()
|
|
109
|
+
})
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
<!--
|
|
113
|
+
Source references:
|
|
114
|
+
- https://vite.dev/guide/features.html#web-workers
|
|
115
|
+
-->
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress
|
|
3
|
+
description: VitePress static site generator powered by Vite and Vue. Use when building documentation sites, configuring themes, or writing Markdown with Vue components.
|
|
4
|
+
metadata:
|
|
5
|
+
author: Anthony Fu
|
|
6
|
+
version: "2026.1.28"
|
|
7
|
+
source: Generated from https://github.com/vuejs/vitepress, scripts located at https://github.com/antfu/skills
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
VitePress is a Static Site Generator (SSG) built on Vite and Vue 3. It takes Markdown content, applies a theme, and generates static HTML that becomes an SPA for fast navigation. Perfect for documentation, blogs, and marketing sites.
|
|
11
|
+
|
|
12
|
+
**Key Characteristics:**
|
|
13
|
+
- File-based routing with `.md` files
|
|
14
|
+
- Vue components work directly in Markdown
|
|
15
|
+
- Fast HMR with instant updates (<100ms)
|
|
16
|
+
- Default theme optimized for documentation
|
|
17
|
+
- Built-in search (local or Algolia)
|
|
18
|
+
|
|
19
|
+
**Before working with VitePress projects:**
|
|
20
|
+
- Check `.vitepress/config.ts` for site configuration
|
|
21
|
+
- Look at `.vitepress/theme/` for custom theme extensions
|
|
22
|
+
- The `public/` directory contains static assets served as-is
|
|
23
|
+
|
|
24
|
+
> The skill is based on VitePress 1.x, generated at 2026-01-28.
|
|
25
|
+
|
|
26
|
+
## Core
|
|
27
|
+
|
|
28
|
+
| Topic | Description | Reference |
|
|
29
|
+
|-------|-------------|-----------|
|
|
30
|
+
| Configuration | Config file setup, defineConfig, site metadata | [core-config](references/core-config.md) |
|
|
31
|
+
| CLI | Command-line interface: dev, build, preview, init | [core-cli](references/core-cli.md) |
|
|
32
|
+
| Routing | File-based routing, source directory, rewrites | [core-routing](references/core-routing.md) |
|
|
33
|
+
| Markdown | Frontmatter, containers, tables, anchors, includes | [core-markdown](references/core-markdown.md) |
|
|
34
|
+
|
|
35
|
+
## Features
|
|
36
|
+
|
|
37
|
+
### Code & Content
|
|
38
|
+
|
|
39
|
+
| Topic | Description | Reference |
|
|
40
|
+
|-------|-------------|-----------|
|
|
41
|
+
| Code Blocks | Syntax highlighting, line highlighting, diffs, focus | [features-code-blocks](references/features-code-blocks.md) |
|
|
42
|
+
| Vue in Markdown | Components, script setup, directives, templating | [features-vue](references/features-vue.md) |
|
|
43
|
+
| Data Loading | Build-time data loaders, createContentLoader | [features-data-loading](references/features-data-loading.md) |
|
|
44
|
+
| Dynamic Routes | Generate pages from data, paths loader files | [features-dynamic-routes](references/features-dynamic-routes.md) |
|
|
45
|
+
|
|
46
|
+
## Theme
|
|
47
|
+
|
|
48
|
+
| Topic | Description | Reference |
|
|
49
|
+
|-------|-------------|-----------|
|
|
50
|
+
| Theme Config | Nav, sidebar, search, social links, footer | [theme-config](references/theme-config.md) |
|
|
51
|
+
| Customization | CSS variables, slots, fonts, global components | [theme-customization](references/theme-customization.md) |
|
|
52
|
+
| Custom Theme | Building themes from scratch, theme interface | [theme-custom](references/theme-custom.md) |
|
|
53
|
+
|
|
54
|
+
## Advanced
|
|
55
|
+
|
|
56
|
+
| Topic | Description | Reference |
|
|
57
|
+
|-------|-------------|-----------|
|
|
58
|
+
| Internationalization | Multi-language sites, locale configuration | [advanced-i18n](references/advanced-i18n.md) |
|
|
59
|
+
| SSR Compatibility | Server-side rendering, ClientOnly, dynamic imports | [advanced-ssr](references/advanced-ssr.md) |
|
|
60
|
+
|
|
61
|
+
## Recipes
|
|
62
|
+
|
|
63
|
+
| Topic | Description | Reference |
|
|
64
|
+
|-------|-------------|-----------|
|
|
65
|
+
| Deployment | GitHub Pages, Netlify, Vercel, Cloudflare, Nginx | [recipes-deploy](references/recipes-deploy.md) |
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-internationalization
|
|
3
|
+
description: Setting up multi-language sites with locale configuration and RTL support
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Internationalization
|
|
7
|
+
|
|
8
|
+
VitePress supports multi-language sites through locale configuration.
|
|
9
|
+
|
|
10
|
+
## Directory Structure
|
|
11
|
+
|
|
12
|
+
Organize content by locale:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
docs/
|
|
16
|
+
├─ en/
|
|
17
|
+
│ ├─ guide.md
|
|
18
|
+
│ └─ index.md
|
|
19
|
+
├─ zh/
|
|
20
|
+
│ ├─ guide.md
|
|
21
|
+
│ └─ index.md
|
|
22
|
+
└─ fr/
|
|
23
|
+
├─ guide.md
|
|
24
|
+
└─ index.md
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Or with root as default language:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
docs/
|
|
31
|
+
├─ guide.md # English (root)
|
|
32
|
+
├─ index.md
|
|
33
|
+
├─ zh/
|
|
34
|
+
│ ├─ guide.md
|
|
35
|
+
│ └─ index.md
|
|
36
|
+
└─ fr/
|
|
37
|
+
├─ guide.md
|
|
38
|
+
└─ index.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Configuration
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
// .vitepress/config.ts
|
|
45
|
+
import { defineConfig } from 'vitepress'
|
|
46
|
+
|
|
47
|
+
export default defineConfig({
|
|
48
|
+
locales: {
|
|
49
|
+
root: {
|
|
50
|
+
label: 'English',
|
|
51
|
+
lang: 'en'
|
|
52
|
+
},
|
|
53
|
+
zh: {
|
|
54
|
+
label: '简体中文',
|
|
55
|
+
lang: 'zh-CN',
|
|
56
|
+
link: '/zh/'
|
|
57
|
+
},
|
|
58
|
+
fr: {
|
|
59
|
+
label: 'Français',
|
|
60
|
+
lang: 'fr',
|
|
61
|
+
link: '/fr/'
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
})
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Locale-Specific Config
|
|
68
|
+
|
|
69
|
+
Override site config per locale:
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
locales: {
|
|
73
|
+
root: {
|
|
74
|
+
label: 'English',
|
|
75
|
+
lang: 'en',
|
|
76
|
+
title: 'My Docs',
|
|
77
|
+
description: 'Documentation site',
|
|
78
|
+
themeConfig: {
|
|
79
|
+
nav: [
|
|
80
|
+
{ text: 'Guide', link: '/guide/' }
|
|
81
|
+
],
|
|
82
|
+
sidebar: {
|
|
83
|
+
'/guide/': [
|
|
84
|
+
{ text: 'Introduction', link: '/guide/' }
|
|
85
|
+
]
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
zh: {
|
|
90
|
+
label: '简体中文',
|
|
91
|
+
lang: 'zh-CN',
|
|
92
|
+
link: '/zh/',
|
|
93
|
+
title: '我的文档',
|
|
94
|
+
description: '文档站点',
|
|
95
|
+
themeConfig: {
|
|
96
|
+
nav: [
|
|
97
|
+
{ text: '指南', link: '/zh/guide/' }
|
|
98
|
+
],
|
|
99
|
+
sidebar: {
|
|
100
|
+
'/zh/guide/': [
|
|
101
|
+
{ text: '介绍', link: '/zh/guide/' }
|
|
102
|
+
]
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Locale-Specific Properties
|
|
110
|
+
|
|
111
|
+
Each locale can override:
|
|
112
|
+
|
|
113
|
+
```ts
|
|
114
|
+
interface LocaleSpecificConfig {
|
|
115
|
+
lang?: string
|
|
116
|
+
dir?: string // 'ltr' or 'rtl'
|
|
117
|
+
title?: string
|
|
118
|
+
titleTemplate?: string | boolean
|
|
119
|
+
description?: string
|
|
120
|
+
head?: HeadConfig[] // Merged with existing
|
|
121
|
+
themeConfig?: ThemeConfig // Shallow merged
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Search i18n
|
|
126
|
+
|
|
127
|
+
### Local Search
|
|
128
|
+
|
|
129
|
+
```ts
|
|
130
|
+
themeConfig: {
|
|
131
|
+
search: {
|
|
132
|
+
provider: 'local',
|
|
133
|
+
options: {
|
|
134
|
+
locales: {
|
|
135
|
+
zh: {
|
|
136
|
+
translations: {
|
|
137
|
+
button: {
|
|
138
|
+
buttonText: '搜索',
|
|
139
|
+
buttonAriaLabel: '搜索'
|
|
140
|
+
},
|
|
141
|
+
modal: {
|
|
142
|
+
noResultsText: '没有结果',
|
|
143
|
+
resetButtonTitle: '重置搜索',
|
|
144
|
+
footer: {
|
|
145
|
+
selectText: '选择',
|
|
146
|
+
navigateText: '导航',
|
|
147
|
+
closeText: '关闭'
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Algolia Search
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
themeConfig: {
|
|
162
|
+
search: {
|
|
163
|
+
provider: 'algolia',
|
|
164
|
+
options: {
|
|
165
|
+
appId: '...',
|
|
166
|
+
apiKey: '...',
|
|
167
|
+
indexName: '...',
|
|
168
|
+
locales: {
|
|
169
|
+
zh: {
|
|
170
|
+
placeholder: '搜索文档',
|
|
171
|
+
translations: {
|
|
172
|
+
button: { buttonText: '搜索文档' }
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
## Separate Locale Directories
|
|
182
|
+
|
|
183
|
+
For fully separated locales without root fallback:
|
|
184
|
+
|
|
185
|
+
```
|
|
186
|
+
docs/
|
|
187
|
+
├─ en/
|
|
188
|
+
│ └─ index.md
|
|
189
|
+
├─ zh/
|
|
190
|
+
│ └─ index.md
|
|
191
|
+
└─ fr/
|
|
192
|
+
└─ index.md
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Requires server redirect for `/` → `/en/`. Netlify example:
|
|
196
|
+
|
|
197
|
+
```
|
|
198
|
+
/* /en/:splat 302 Language=en
|
|
199
|
+
/* /zh/:splat 302 Language=zh
|
|
200
|
+
/* /en/:splat 302
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Persisting Language Choice
|
|
204
|
+
|
|
205
|
+
Set cookie on language change:
|
|
206
|
+
|
|
207
|
+
```vue
|
|
208
|
+
<!-- .vitepress/theme/Layout.vue -->
|
|
209
|
+
<script setup>
|
|
210
|
+
import DefaultTheme from 'vitepress/theme'
|
|
211
|
+
import { useData, inBrowser } from 'vitepress'
|
|
212
|
+
import { watchEffect } from 'vue'
|
|
213
|
+
|
|
214
|
+
const { lang } = useData()
|
|
215
|
+
|
|
216
|
+
watchEffect(() => {
|
|
217
|
+
if (inBrowser) {
|
|
218
|
+
document.cookie = `nf_lang=${lang.value}; expires=Mon, 1 Jan 2030 00:00:00 UTC; path=/`
|
|
219
|
+
}
|
|
220
|
+
})
|
|
221
|
+
</script>
|
|
222
|
+
|
|
223
|
+
<template>
|
|
224
|
+
<DefaultTheme.Layout />
|
|
225
|
+
</template>
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## RTL Support (Experimental)
|
|
229
|
+
|
|
230
|
+
For right-to-left languages:
|
|
231
|
+
|
|
232
|
+
```ts
|
|
233
|
+
locales: {
|
|
234
|
+
ar: {
|
|
235
|
+
label: 'العربية',
|
|
236
|
+
lang: 'ar',
|
|
237
|
+
dir: 'rtl'
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Requires PostCSS plugin like `postcss-rtlcss`:
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
// postcss.config.js
|
|
246
|
+
import rtlcss from 'postcss-rtlcss'
|
|
247
|
+
|
|
248
|
+
export default {
|
|
249
|
+
plugins: [
|
|
250
|
+
rtlcss({
|
|
251
|
+
ltrPrefix: ':where([dir="ltr"])',
|
|
252
|
+
rtlPrefix: ':where([dir="rtl"])'
|
|
253
|
+
})
|
|
254
|
+
]
|
|
255
|
+
}
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
## Organizing Config
|
|
259
|
+
|
|
260
|
+
Split config into separate files:
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
.vitepress/
|
|
264
|
+
├─ config/
|
|
265
|
+
│ ├─ index.ts # Main config, merges locales
|
|
266
|
+
│ ├─ en.ts # English config
|
|
267
|
+
│ ├─ zh.ts # Chinese config
|
|
268
|
+
│ └─ shared.ts # Shared config
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
```ts
|
|
272
|
+
// .vitepress/config/index.ts
|
|
273
|
+
import { defineConfig } from 'vitepress'
|
|
274
|
+
import { shared } from './shared'
|
|
275
|
+
import { en } from './en'
|
|
276
|
+
import { zh } from './zh'
|
|
277
|
+
|
|
278
|
+
export default defineConfig({
|
|
279
|
+
...shared,
|
|
280
|
+
locales: {
|
|
281
|
+
root: { label: 'English', ...en },
|
|
282
|
+
zh: { label: '简体中文', ...zh }
|
|
283
|
+
}
|
|
284
|
+
})
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
## Key Points
|
|
288
|
+
|
|
289
|
+
- Use `locales` object in config with `root` for default language
|
|
290
|
+
- Each locale can override title, description, and themeConfig
|
|
291
|
+
- `themeConfig` is shallow merged (define complete nav/sidebar per locale)
|
|
292
|
+
- Don't override `themeConfig.algolia` at locale level
|
|
293
|
+
- `dir: 'rtl'` enables RTL with PostCSS plugin
|
|
294
|
+
- Language switcher appears automatically in nav
|
|
295
|
+
|
|
296
|
+
<!--
|
|
297
|
+
Source references:
|
|
298
|
+
- https://vitepress.dev/guide/i18n
|
|
299
|
+
-->
|
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-ssr-compatibility
|
|
3
|
+
description: Server-side rendering compatibility, ClientOnly component, and handling browser-only code
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# SSR Compatibility
|
|
7
|
+
|
|
8
|
+
VitePress pre-renders pages on the server during build. All Vue code must be SSR-compatible.
|
|
9
|
+
|
|
10
|
+
## The Rule
|
|
11
|
+
|
|
12
|
+
Only access browser/DOM APIs in Vue lifecycle hooks:
|
|
13
|
+
- `onMounted()`
|
|
14
|
+
- `onBeforeMount()`
|
|
15
|
+
|
|
16
|
+
```vue
|
|
17
|
+
<script setup>
|
|
18
|
+
import { onMounted, ref } from 'vue'
|
|
19
|
+
|
|
20
|
+
const windowWidth = ref(0)
|
|
21
|
+
|
|
22
|
+
onMounted(() => {
|
|
23
|
+
// Safe - runs only in browser
|
|
24
|
+
windowWidth.value = window.innerWidth
|
|
25
|
+
})
|
|
26
|
+
</script>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Do NOT** access at top level:
|
|
30
|
+
|
|
31
|
+
```vue
|
|
32
|
+
<script setup>
|
|
33
|
+
// WRONG - runs during SSR where window doesn't exist
|
|
34
|
+
const width = window.innerWidth
|
|
35
|
+
</script>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## ClientOnly Component
|
|
39
|
+
|
|
40
|
+
Wrap non-SSR-friendly components:
|
|
41
|
+
|
|
42
|
+
```vue
|
|
43
|
+
<template>
|
|
44
|
+
<ClientOnly>
|
|
45
|
+
<BrowserOnlyComponent />
|
|
46
|
+
</ClientOnly>
|
|
47
|
+
</template>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Libraries That Access Browser on Import
|
|
51
|
+
|
|
52
|
+
Some libraries access `window` or `document` when imported:
|
|
53
|
+
|
|
54
|
+
### Dynamic Import in onMounted
|
|
55
|
+
|
|
56
|
+
```vue
|
|
57
|
+
<script setup>
|
|
58
|
+
import { onMounted } from 'vue'
|
|
59
|
+
|
|
60
|
+
onMounted(async () => {
|
|
61
|
+
const lib = await import('browser-only-library')
|
|
62
|
+
lib.doSomething()
|
|
63
|
+
})
|
|
64
|
+
</script>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Conditional Import
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
if (!import.meta.env.SSR) {
|
|
71
|
+
const lib = await import('browser-only-library')
|
|
72
|
+
lib.doSomething()
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### In enhanceApp
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
// .vitepress/theme/index.ts
|
|
80
|
+
export default {
|
|
81
|
+
async enhanceApp({ app }) {
|
|
82
|
+
if (!import.meta.env.SSR) {
|
|
83
|
+
const plugin = await import('browser-plugin')
|
|
84
|
+
app.use(plugin.default)
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## defineClientComponent
|
|
91
|
+
|
|
92
|
+
Helper for components that access browser on import:
|
|
93
|
+
|
|
94
|
+
```vue
|
|
95
|
+
<script setup>
|
|
96
|
+
import { defineClientComponent } from 'vitepress'
|
|
97
|
+
|
|
98
|
+
const BrowserComponent = defineClientComponent(() => {
|
|
99
|
+
return import('browser-only-component')
|
|
100
|
+
})
|
|
101
|
+
</script>
|
|
102
|
+
|
|
103
|
+
<template>
|
|
104
|
+
<BrowserComponent />
|
|
105
|
+
</template>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
With props and slots:
|
|
109
|
+
|
|
110
|
+
```vue
|
|
111
|
+
<script setup>
|
|
112
|
+
import { ref, h } from 'vue'
|
|
113
|
+
import { defineClientComponent } from 'vitepress'
|
|
114
|
+
|
|
115
|
+
const componentRef = ref(null)
|
|
116
|
+
|
|
117
|
+
const BrowserComponent = defineClientComponent(
|
|
118
|
+
() => import('browser-only-component'),
|
|
119
|
+
// Props passed to h()
|
|
120
|
+
[
|
|
121
|
+
{ ref: componentRef, someProp: 'value' },
|
|
122
|
+
{
|
|
123
|
+
default: () => 'Default slot content',
|
|
124
|
+
header: () => h('div', 'Header slot')
|
|
125
|
+
}
|
|
126
|
+
],
|
|
127
|
+
// Callback after component loads
|
|
128
|
+
() => {
|
|
129
|
+
console.log('Component loaded', componentRef.value)
|
|
130
|
+
}
|
|
131
|
+
)
|
|
132
|
+
</script>
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Teleports
|
|
136
|
+
|
|
137
|
+
Teleport to body only with SSG:
|
|
138
|
+
|
|
139
|
+
```vue
|
|
140
|
+
<ClientOnly>
|
|
141
|
+
<Teleport to="body">
|
|
142
|
+
<div class="modal">Modal content</div>
|
|
143
|
+
</Teleport>
|
|
144
|
+
</ClientOnly>
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
For other targets, use `postRender` hook:
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
// .vitepress/config.ts
|
|
151
|
+
export default {
|
|
152
|
+
async postRender(context) {
|
|
153
|
+
// Inject teleport content into final HTML
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## Common SSR Errors
|
|
159
|
+
|
|
160
|
+
### "window is not defined"
|
|
161
|
+
|
|
162
|
+
Code accesses `window` at module level:
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
// BAD
|
|
166
|
+
const width = window.innerWidth
|
|
167
|
+
|
|
168
|
+
// GOOD
|
|
169
|
+
let width: number
|
|
170
|
+
onMounted(() => {
|
|
171
|
+
width = window.innerWidth
|
|
172
|
+
})
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### "document is not defined"
|
|
176
|
+
|
|
177
|
+
Same issue with `document`:
|
|
178
|
+
|
|
179
|
+
```ts
|
|
180
|
+
// BAD
|
|
181
|
+
const el = document.querySelector('#app')
|
|
182
|
+
|
|
183
|
+
// GOOD
|
|
184
|
+
onMounted(() => {
|
|
185
|
+
const el = document.querySelector('#app')
|
|
186
|
+
})
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Hydration Mismatch
|
|
190
|
+
|
|
191
|
+
Server and client render different content:
|
|
192
|
+
|
|
193
|
+
```vue
|
|
194
|
+
<!-- BAD - different on server vs client -->
|
|
195
|
+
<div>{{ typeof window !== 'undefined' ? 'client' : 'server' }}</div>
|
|
196
|
+
|
|
197
|
+
<!-- GOOD - consistent -->
|
|
198
|
+
<ClientOnly>
|
|
199
|
+
<div>Client only content</div>
|
|
200
|
+
</ClientOnly>
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Checking Environment
|
|
204
|
+
|
|
205
|
+
```ts
|
|
206
|
+
// In Vue component
|
|
207
|
+
import.meta.env.SSR // true on server, false on client
|
|
208
|
+
|
|
209
|
+
// In VitePress
|
|
210
|
+
import { inBrowser } from 'vitepress'
|
|
211
|
+
if (inBrowser) {
|
|
212
|
+
// Client-only code
|
|
213
|
+
}
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
## Key Points
|
|
217
|
+
|
|
218
|
+
- Access browser APIs only in `onMounted` or `onBeforeMount`
|
|
219
|
+
- Use `<ClientOnly>` for non-SSR components
|
|
220
|
+
- Use `defineClientComponent` for libraries that access browser on import
|
|
221
|
+
- Check `import.meta.env.SSR` for environment-specific code
|
|
222
|
+
- Teleport to body only, or use `postRender` hook
|
|
223
|
+
- Consistent rendering prevents hydration mismatches
|
|
224
|
+
|
|
225
|
+
<!--
|
|
226
|
+
Source references:
|
|
227
|
+
- https://vitepress.dev/guide/ssr-compat
|
|
228
|
+
-->
|