aico-cli 2.1.7 → 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 +8672 -3345
- package/bin/cli/package.json +1 -1
- package/bin/cli/sdk-tools.d.ts +41 -5
- package/dist/chunks/simple-config.mjs +1 -1
- package/package.json +2 -2
- 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,169 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-routing
|
|
3
|
+
description: File-based routing, source directory structure, clean URLs, and route rewrites
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Routing
|
|
7
|
+
|
|
8
|
+
VitePress uses file-based routing where markdown files map directly to HTML pages.
|
|
9
|
+
|
|
10
|
+
## File to URL Mapping
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
.
|
|
14
|
+
├─ index.md → /index.html (/)
|
|
15
|
+
├─ about.md → /about.html
|
|
16
|
+
├─ guide/
|
|
17
|
+
│ ├─ index.md → /guide/index.html (/guide/)
|
|
18
|
+
│ └─ getting-started.md → /guide/getting-started.html
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Project Structure
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
.
|
|
25
|
+
├─ docs # Project root
|
|
26
|
+
│ ├─ .vitepress # VitePress directory
|
|
27
|
+
│ │ ├─ config.ts # Configuration
|
|
28
|
+
│ │ ├─ theme/ # Custom theme
|
|
29
|
+
│ │ ├─ cache/ # Dev server cache (gitignore)
|
|
30
|
+
│ │ └─ dist/ # Build output (gitignore)
|
|
31
|
+
│ ├─ public/ # Static assets (copied as-is)
|
|
32
|
+
│ ├─ index.md # Home page
|
|
33
|
+
│ └─ guide/
|
|
34
|
+
│ └─ intro.md
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Source Directory
|
|
38
|
+
|
|
39
|
+
Separate source files from project root:
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
// .vitepress/config.ts
|
|
43
|
+
export default {
|
|
44
|
+
srcDir: './src' // Markdown files live in ./src/
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
With `srcDir: 'src'`:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
.
|
|
52
|
+
├─ .vitepress/ # Config stays at project root
|
|
53
|
+
└─ src/ # Source directory
|
|
54
|
+
├─ index.md → /
|
|
55
|
+
└─ guide/intro.md → /guide/intro.html
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Linking Between Pages
|
|
59
|
+
|
|
60
|
+
Use relative or absolute paths. Omit file extensions:
|
|
61
|
+
|
|
62
|
+
```md
|
|
63
|
+
<!-- Recommended -->
|
|
64
|
+
[Getting Started](./getting-started)
|
|
65
|
+
[Guide](/guide/)
|
|
66
|
+
|
|
67
|
+
<!-- Works but not recommended -->
|
|
68
|
+
[Getting Started](./getting-started.md)
|
|
69
|
+
[Getting Started](./getting-started.html)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Clean URLs
|
|
73
|
+
|
|
74
|
+
Remove `.html` extension from URLs (requires server support):
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
export default {
|
|
78
|
+
cleanUrls: true
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Server requirements:**
|
|
83
|
+
- Netlify, GitHub Pages: Supported by default
|
|
84
|
+
- Vercel: Enable `cleanUrls` in `vercel.json`
|
|
85
|
+
- Nginx: Configure `try_files $uri $uri.html $uri/ =404`
|
|
86
|
+
|
|
87
|
+
## Route Rewrites
|
|
88
|
+
|
|
89
|
+
Customize the mapping between source and output paths:
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
export default {
|
|
93
|
+
rewrites: {
|
|
94
|
+
// Static mapping
|
|
95
|
+
'packages/pkg-a/src/index.md': 'pkg-a/index.md',
|
|
96
|
+
'packages/pkg-a/src/foo.md': 'pkg-a/foo.md',
|
|
97
|
+
|
|
98
|
+
// Dynamic parameters
|
|
99
|
+
'packages/:pkg/src/:slug*': ':pkg/:slug*'
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
This maps `packages/pkg-a/src/intro.md` → `/pkg-a/intro.html`.
|
|
105
|
+
|
|
106
|
+
**Important:** Relative links in rewritten files should be based on the rewritten path, not the source path.
|
|
107
|
+
|
|
108
|
+
Rewrites can also be a function:
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
export default {
|
|
112
|
+
rewrites(id) {
|
|
113
|
+
return id.replace(/^packages\/([^/]+)\/src\//, '$1/')
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Public Directory
|
|
119
|
+
|
|
120
|
+
Files in `public/` are copied to output root as-is:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
docs/public/
|
|
124
|
+
├─ favicon.ico → /favicon.ico
|
|
125
|
+
├─ robots.txt → /robots.txt
|
|
126
|
+
└─ images/logo.png → /images/logo.png
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Reference with absolute paths:
|
|
130
|
+
|
|
131
|
+
```md
|
|
132
|
+

|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Base URL
|
|
136
|
+
|
|
137
|
+
For sub-path deployment (e.g., GitHub Pages):
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
export default {
|
|
141
|
+
base: '/repo-name/'
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
All absolute paths are automatically prefixed with base. For dynamic paths in components, use `withBase`:
|
|
146
|
+
|
|
147
|
+
```vue
|
|
148
|
+
<script setup>
|
|
149
|
+
import { withBase } from 'vitepress'
|
|
150
|
+
</script>
|
|
151
|
+
|
|
152
|
+
<template>
|
|
153
|
+
<img :src="withBase('/logo.png')" />
|
|
154
|
+
</template>
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Key Points
|
|
158
|
+
|
|
159
|
+
- `index.md` files map to directory root (`/guide/` instead of `/guide/index`)
|
|
160
|
+
- Use paths without extensions in links for flexibility
|
|
161
|
+
- `srcDir` separates source from config
|
|
162
|
+
- `cleanUrls` removes `.html` but requires server support
|
|
163
|
+
- `rewrites` enables complex source structures with clean output URLs
|
|
164
|
+
|
|
165
|
+
<!--
|
|
166
|
+
Source references:
|
|
167
|
+
- https://vitepress.dev/guide/routing
|
|
168
|
+
- https://vitepress.dev/guide/asset-handling
|
|
169
|
+
-->
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-code-blocks
|
|
3
|
+
description: Syntax highlighting, line highlighting, colored diffs, focus, and line numbers
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Code Blocks
|
|
7
|
+
|
|
8
|
+
VitePress uses Shiki for syntax highlighting with powerful code block features.
|
|
9
|
+
|
|
10
|
+
## Syntax Highlighting
|
|
11
|
+
|
|
12
|
+
Specify language after opening backticks:
|
|
13
|
+
|
|
14
|
+
````md
|
|
15
|
+
```js
|
|
16
|
+
export default {
|
|
17
|
+
name: 'MyComponent'
|
|
18
|
+
}
|
|
19
|
+
```
|
|
20
|
+
````
|
|
21
|
+
|
|
22
|
+
Supports [all languages](https://shiki.style/languages) available in Shiki.
|
|
23
|
+
|
|
24
|
+
## Line Highlighting
|
|
25
|
+
|
|
26
|
+
Highlight specific lines:
|
|
27
|
+
|
|
28
|
+
````md
|
|
29
|
+
```js{4}
|
|
30
|
+
export default {
|
|
31
|
+
data() {
|
|
32
|
+
return {
|
|
33
|
+
msg: 'Highlighted!' // Line 4 highlighted
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
````
|
|
39
|
+
|
|
40
|
+
Multiple lines and ranges:
|
|
41
|
+
|
|
42
|
+
````md
|
|
43
|
+
```js{1,4,6-8}
|
|
44
|
+
// Line 1 highlighted
|
|
45
|
+
export default {
|
|
46
|
+
data() {
|
|
47
|
+
return { // Line 4
|
|
48
|
+
msg: 'Hi',
|
|
49
|
+
foo: 'bar', // Lines 6-8
|
|
50
|
+
baz: 'qux'
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
````
|
|
56
|
+
|
|
57
|
+
Inline highlighting with comment:
|
|
58
|
+
|
|
59
|
+
````md
|
|
60
|
+
```js
|
|
61
|
+
export default {
|
|
62
|
+
data() {
|
|
63
|
+
return {
|
|
64
|
+
msg: 'Highlighted!' // [!code highlight]
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
````
|
|
70
|
+
|
|
71
|
+
## Focus
|
|
72
|
+
|
|
73
|
+
Blur other code and focus specific lines:
|
|
74
|
+
|
|
75
|
+
````md
|
|
76
|
+
```js
|
|
77
|
+
export default {
|
|
78
|
+
data() {
|
|
79
|
+
return {
|
|
80
|
+
msg: 'Focused!' // [!code focus]
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
````
|
|
86
|
+
|
|
87
|
+
Focus multiple lines:
|
|
88
|
+
|
|
89
|
+
```js
|
|
90
|
+
// [!code focus:3]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Colored Diffs
|
|
94
|
+
|
|
95
|
+
Show additions and removals:
|
|
96
|
+
|
|
97
|
+
````md
|
|
98
|
+
```js
|
|
99
|
+
export default {
|
|
100
|
+
data() {
|
|
101
|
+
return {
|
|
102
|
+
msg: 'Removed' // [!code --]
|
|
103
|
+
msg: 'Added' // [!code ++]
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
````
|
|
109
|
+
|
|
110
|
+
## Errors and Warnings
|
|
111
|
+
|
|
112
|
+
Color lines as errors or warnings:
|
|
113
|
+
|
|
114
|
+
````md
|
|
115
|
+
```js
|
|
116
|
+
export default {
|
|
117
|
+
data() {
|
|
118
|
+
return {
|
|
119
|
+
msg: 'Error', // [!code error]
|
|
120
|
+
msg: 'Warning' // [!code warning]
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
````
|
|
126
|
+
|
|
127
|
+
## Line Numbers
|
|
128
|
+
|
|
129
|
+
Enable globally:
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
// .vitepress/config.ts
|
|
133
|
+
export default {
|
|
134
|
+
markdown: {
|
|
135
|
+
lineNumbers: true
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Per-block override:
|
|
141
|
+
|
|
142
|
+
````md
|
|
143
|
+
```ts:line-numbers
|
|
144
|
+
// Line numbers enabled
|
|
145
|
+
const a = 1
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
```ts:no-line-numbers
|
|
149
|
+
// Line numbers disabled
|
|
150
|
+
const b = 2
|
|
151
|
+
```
|
|
152
|
+
````
|
|
153
|
+
|
|
154
|
+
Start from specific number:
|
|
155
|
+
|
|
156
|
+
````md
|
|
157
|
+
```ts:line-numbers=5
|
|
158
|
+
// Starts at line 5
|
|
159
|
+
const a = 1 // This is line 5
|
|
160
|
+
const b = 2 // This is line 6
|
|
161
|
+
```
|
|
162
|
+
````
|
|
163
|
+
|
|
164
|
+
## Code Groups
|
|
165
|
+
|
|
166
|
+
Tabbed code blocks:
|
|
167
|
+
|
|
168
|
+
````md
|
|
169
|
+
::: code-group
|
|
170
|
+
|
|
171
|
+
```js [JavaScript]
|
|
172
|
+
export default { /* ... */ }
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
```ts [TypeScript]
|
|
176
|
+
export default defineConfig({ /* ... */ })
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
:::
|
|
180
|
+
````
|
|
181
|
+
|
|
182
|
+
## Import Code Snippets
|
|
183
|
+
|
|
184
|
+
From external files:
|
|
185
|
+
|
|
186
|
+
```md
|
|
187
|
+
<<< @/snippets/snippet.js
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
With highlighting:
|
|
191
|
+
|
|
192
|
+
```md
|
|
193
|
+
<<< @/snippets/snippet.js{2,4-6}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Specific region:
|
|
197
|
+
|
|
198
|
+
```md
|
|
199
|
+
<<< @/snippets/snippet.js#regionName{1,2}
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
With language and line numbers:
|
|
203
|
+
|
|
204
|
+
```md
|
|
205
|
+
<<< @/snippets/snippet.cs{1,2,4-6 c#:line-numbers}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
In code groups:
|
|
209
|
+
|
|
210
|
+
```md
|
|
211
|
+
::: code-group
|
|
212
|
+
|
|
213
|
+
<<< @/snippets/config.js [JavaScript]
|
|
214
|
+
<<< @/snippets/config.ts [TypeScript]
|
|
215
|
+
|
|
216
|
+
:::
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## File Labels
|
|
220
|
+
|
|
221
|
+
Add filename labels to code blocks:
|
|
222
|
+
|
|
223
|
+
````md
|
|
224
|
+
```js [vite.config.js]
|
|
225
|
+
export default defineConfig({})
|
|
226
|
+
```
|
|
227
|
+
````
|
|
228
|
+
|
|
229
|
+
## Key Points
|
|
230
|
+
|
|
231
|
+
- Use `// [!code highlight]` for inline highlighting
|
|
232
|
+
- Use `// [!code focus]` to focus with blur effect
|
|
233
|
+
- Use `// [!code ++]` and `// [!code --]` for diffs
|
|
234
|
+
- Use `// [!code error]` and `// [!code warning]` for status
|
|
235
|
+
- `:line-numbers` and `:no-line-numbers` control line numbers per block
|
|
236
|
+
- `@` in imports refers to source root
|
|
237
|
+
- Code groups create tabbed interfaces
|
|
238
|
+
|
|
239
|
+
<!--
|
|
240
|
+
Source references:
|
|
241
|
+
- https://vitepress.dev/guide/markdown#syntax-highlighting-in-code-blocks
|
|
242
|
+
- https://vitepress.dev/guide/markdown#line-highlighting-in-code-blocks
|
|
243
|
+
-->
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-data-loading
|
|
3
|
+
description: Build-time data loaders for fetching remote data or processing local files
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Data Loading
|
|
7
|
+
|
|
8
|
+
VitePress data loaders run at build time to load arbitrary data that's serialized as JSON in the client bundle.
|
|
9
|
+
|
|
10
|
+
## Basic Usage
|
|
11
|
+
|
|
12
|
+
Create a file ending with `.data.js` or `.data.ts`:
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
// example.data.ts
|
|
16
|
+
export default {
|
|
17
|
+
load() {
|
|
18
|
+
return {
|
|
19
|
+
hello: 'world',
|
|
20
|
+
timestamp: Date.now()
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Import the `data` named export:
|
|
27
|
+
|
|
28
|
+
```vue
|
|
29
|
+
<script setup>
|
|
30
|
+
import { data } from './example.data.ts'
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<template>
|
|
34
|
+
<pre>{{ data }}</pre>
|
|
35
|
+
</template>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Async Data
|
|
39
|
+
|
|
40
|
+
Fetch remote data:
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
// api.data.ts
|
|
44
|
+
export default {
|
|
45
|
+
async load() {
|
|
46
|
+
const response = await fetch('https://api.example.com/data')
|
|
47
|
+
return response.json()
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Local Files with Watch
|
|
53
|
+
|
|
54
|
+
Process local files with hot reload:
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
// posts.data.ts
|
|
58
|
+
import fs from 'node:fs'
|
|
59
|
+
import { parse } from 'csv-parse/sync'
|
|
60
|
+
|
|
61
|
+
export default {
|
|
62
|
+
watch: ['./data/*.csv'],
|
|
63
|
+
load(watchedFiles) {
|
|
64
|
+
// watchedFiles = array of absolute paths
|
|
65
|
+
return watchedFiles.map(file => {
|
|
66
|
+
return parse(fs.readFileSync(file, 'utf-8'), {
|
|
67
|
+
columns: true,
|
|
68
|
+
skip_empty_lines: true
|
|
69
|
+
})
|
|
70
|
+
})
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## createContentLoader
|
|
76
|
+
|
|
77
|
+
Helper for loading markdown content (common for blogs/archives):
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
// posts.data.ts
|
|
81
|
+
import { createContentLoader } from 'vitepress'
|
|
82
|
+
|
|
83
|
+
export default createContentLoader('posts/*.md')
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Returns array of `ContentData`:
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
interface ContentData {
|
|
90
|
+
url: string // e.g. /posts/hello.html
|
|
91
|
+
frontmatter: Record<string, any>
|
|
92
|
+
src?: string // raw markdown (opt-in)
|
|
93
|
+
html?: string // rendered HTML (opt-in)
|
|
94
|
+
excerpt?: string // excerpt HTML (opt-in)
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
With options:
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
// posts.data.ts
|
|
102
|
+
import { createContentLoader } from 'vitepress'
|
|
103
|
+
|
|
104
|
+
export default createContentLoader('posts/*.md', {
|
|
105
|
+
includeSrc: true, // Include raw markdown
|
|
106
|
+
render: true, // Include rendered HTML
|
|
107
|
+
excerpt: true, // Include excerpt (content before first ---)
|
|
108
|
+
|
|
109
|
+
transform(rawData) {
|
|
110
|
+
// Sort by date, newest first
|
|
111
|
+
return rawData
|
|
112
|
+
.sort((a, b) => +new Date(b.frontmatter.date) - +new Date(a.frontmatter.date))
|
|
113
|
+
.map(page => ({
|
|
114
|
+
title: page.frontmatter.title,
|
|
115
|
+
url: page.url,
|
|
116
|
+
date: page.frontmatter.date,
|
|
117
|
+
excerpt: page.excerpt
|
|
118
|
+
}))
|
|
119
|
+
}
|
|
120
|
+
})
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Usage Example: Blog Index
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
// posts.data.ts
|
|
127
|
+
import { createContentLoader } from 'vitepress'
|
|
128
|
+
|
|
129
|
+
export default createContentLoader('posts/*.md', {
|
|
130
|
+
excerpt: true,
|
|
131
|
+
transform(data) {
|
|
132
|
+
return data
|
|
133
|
+
.filter(post => !post.frontmatter.draft)
|
|
134
|
+
.sort((a, b) => +new Date(b.frontmatter.date) - +new Date(a.frontmatter.date))
|
|
135
|
+
}
|
|
136
|
+
})
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
```vue
|
|
140
|
+
<!-- posts/index.md -->
|
|
141
|
+
<script setup>
|
|
142
|
+
import { data as posts } from './posts.data.ts'
|
|
143
|
+
</script>
|
|
144
|
+
|
|
145
|
+
<template>
|
|
146
|
+
<ul>
|
|
147
|
+
<li v-for="post in posts" :key="post.url">
|
|
148
|
+
<a :href="post.url">{{ post.frontmatter.title }}</a>
|
|
149
|
+
<span>{{ post.frontmatter.date }}</span>
|
|
150
|
+
</li>
|
|
151
|
+
</ul>
|
|
152
|
+
</template>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Typed Data Loaders
|
|
156
|
+
|
|
157
|
+
```ts
|
|
158
|
+
// example.data.ts
|
|
159
|
+
import { defineLoader } from 'vitepress'
|
|
160
|
+
|
|
161
|
+
export interface Data {
|
|
162
|
+
posts: Array<{ title: string; url: string }>
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
declare const data: Data
|
|
166
|
+
export { data }
|
|
167
|
+
|
|
168
|
+
export default defineLoader({
|
|
169
|
+
watch: ['./posts/*.md'],
|
|
170
|
+
async load(): Promise<Data> {
|
|
171
|
+
// ...
|
|
172
|
+
return { posts: [] }
|
|
173
|
+
}
|
|
174
|
+
})
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## In Build Hooks
|
|
178
|
+
|
|
179
|
+
Use in config for generating additional files:
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
// .vitepress/config.ts
|
|
183
|
+
import { createContentLoader } from 'vitepress'
|
|
184
|
+
|
|
185
|
+
export default {
|
|
186
|
+
async buildEnd() {
|
|
187
|
+
const posts = await createContentLoader('posts/*.md').load()
|
|
188
|
+
// Generate RSS feed, sitemap, etc.
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## Accessing Config
|
|
194
|
+
|
|
195
|
+
```ts
|
|
196
|
+
// example.data.ts
|
|
197
|
+
import type { SiteConfig } from 'vitepress'
|
|
198
|
+
|
|
199
|
+
export default {
|
|
200
|
+
load() {
|
|
201
|
+
const config: SiteConfig = (globalThis as any).VITEPRESS_CONFIG
|
|
202
|
+
return { base: config.site.base }
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## Key Points
|
|
208
|
+
|
|
209
|
+
- Data loaders run only at build time in Node.js
|
|
210
|
+
- File must end with `.data.js` or `.data.ts`
|
|
211
|
+
- Import the `data` named export (not default)
|
|
212
|
+
- Use `watch` for local file hot reload during dev
|
|
213
|
+
- `createContentLoader` simplifies loading markdown collections
|
|
214
|
+
- Keep data small - it's inlined in the client bundle
|
|
215
|
+
- Heavy data should use `transform` to reduce payload
|
|
216
|
+
|
|
217
|
+
<!--
|
|
218
|
+
Source references:
|
|
219
|
+
- https://vitepress.dev/guide/data-loading
|
|
220
|
+
-->
|