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,119 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-cli
|
|
3
|
+
description: Command-line interface for development, building, and previewing VitePress sites
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# CLI Commands
|
|
7
|
+
|
|
8
|
+
VitePress provides four main commands: `dev`, `build`, `preview`, and `init`.
|
|
9
|
+
|
|
10
|
+
## Development Server
|
|
11
|
+
|
|
12
|
+
Start the dev server with hot module replacement:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
# In current directory (dev command is optional)
|
|
16
|
+
vitepress
|
|
17
|
+
|
|
18
|
+
# Or explicitly
|
|
19
|
+
vitepress dev
|
|
20
|
+
|
|
21
|
+
# With project in subdirectory
|
|
22
|
+
vitepress dev docs
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Options:**
|
|
26
|
+
|
|
27
|
+
| Option | Description |
|
|
28
|
+
|--------|-------------|
|
|
29
|
+
| `--open [path]` | Open browser on startup |
|
|
30
|
+
| `--port <port>` | Specify port number |
|
|
31
|
+
| `--base <path>` | Override base URL |
|
|
32
|
+
| `--cors` | Enable CORS |
|
|
33
|
+
| `--strictPort` | Exit if port is in use |
|
|
34
|
+
| `--force` | Ignore cache and re-bundle |
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
vitepress dev docs --port 3000 --open
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Production Build
|
|
41
|
+
|
|
42
|
+
Build static files for production:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
vitepress build docs
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Options:**
|
|
49
|
+
|
|
50
|
+
| Option | Description |
|
|
51
|
+
|--------|-------------|
|
|
52
|
+
| `--base <path>` | Override base URL |
|
|
53
|
+
| `--target <target>` | Transpile target (default: `modules`) |
|
|
54
|
+
| `--outDir <dir>` | Output directory (relative to cwd) |
|
|
55
|
+
| `--assetsInlineLimit <n>` | Asset inline threshold in bytes |
|
|
56
|
+
| `--mpa` | Build in MPA mode (no client hydration) |
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
vitepress build docs --outDir dist
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Preview Production Build
|
|
63
|
+
|
|
64
|
+
Locally preview the production build:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
vitepress preview docs
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
**Options:**
|
|
71
|
+
|
|
72
|
+
| Option | Description |
|
|
73
|
+
|--------|-------------|
|
|
74
|
+
| `--port <port>` | Specify port number |
|
|
75
|
+
| `--base <path>` | Override base URL |
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
vitepress preview docs --port 4173
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Initialize Project
|
|
82
|
+
|
|
83
|
+
Start the setup wizard:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
vitepress init
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
This creates the basic file structure:
|
|
90
|
+
- `.vitepress/config.js` - Configuration
|
|
91
|
+
- `index.md` - Home page
|
|
92
|
+
- Optional example pages
|
|
93
|
+
|
|
94
|
+
## Package.json Scripts
|
|
95
|
+
|
|
96
|
+
Typical scripts configuration:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"scripts": {
|
|
101
|
+
"docs:dev": "vitepress dev docs",
|
|
102
|
+
"docs:build": "vitepress build docs",
|
|
103
|
+
"docs:preview": "vitepress preview docs"
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Key Points
|
|
109
|
+
|
|
110
|
+
- Dev server runs at `http://localhost:5173` by default
|
|
111
|
+
- Preview server runs at `http://localhost:4173`
|
|
112
|
+
- Production output goes to `.vitepress/dist` by default
|
|
113
|
+
- The `docs` argument specifies the project root directory
|
|
114
|
+
- Use `--base` to override base path without modifying config
|
|
115
|
+
|
|
116
|
+
<!--
|
|
117
|
+
Source references:
|
|
118
|
+
- https://vitepress.dev/reference/cli
|
|
119
|
+
-->
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-configuration
|
|
3
|
+
description: Config file setup, defineConfig helper, site metadata, and build options
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Configuration
|
|
7
|
+
|
|
8
|
+
VitePress configuration is defined in `.vitepress/config.[js|ts|mjs|mts]`. Use `defineConfig` for TypeScript intellisense.
|
|
9
|
+
|
|
10
|
+
## Basic Config
|
|
11
|
+
|
|
12
|
+
```ts
|
|
13
|
+
// .vitepress/config.ts
|
|
14
|
+
import { defineConfig } from 'vitepress'
|
|
15
|
+
|
|
16
|
+
export default defineConfig({
|
|
17
|
+
// Site metadata
|
|
18
|
+
title: 'My Docs',
|
|
19
|
+
description: 'Documentation site',
|
|
20
|
+
lang: 'en-US',
|
|
21
|
+
|
|
22
|
+
// URL base path (for GitHub Pages: '/repo-name/')
|
|
23
|
+
base: '/',
|
|
24
|
+
|
|
25
|
+
// Theme configuration
|
|
26
|
+
themeConfig: {
|
|
27
|
+
// See theme-config.md
|
|
28
|
+
}
|
|
29
|
+
})
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Site Metadata
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
export default defineConfig({
|
|
36
|
+
title: 'VitePress', // Displayed in nav, used in page titles
|
|
37
|
+
titleTemplate: ':title - Docs', // Page title format (:title = h1)
|
|
38
|
+
description: 'Site description', // Meta description
|
|
39
|
+
lang: 'en-US', // HTML lang attribute
|
|
40
|
+
|
|
41
|
+
head: [
|
|
42
|
+
['link', { rel: 'icon', href: '/favicon.ico' }],
|
|
43
|
+
['meta', { name: 'theme-color', content: '#5f67ee' }],
|
|
44
|
+
['script', { async: '', src: 'https://analytics.example.com/script.js' }]
|
|
45
|
+
]
|
|
46
|
+
})
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Build Options
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
export default defineConfig({
|
|
53
|
+
// Source files directory (relative to project root)
|
|
54
|
+
srcDir: './src',
|
|
55
|
+
|
|
56
|
+
// Exclude patterns from source
|
|
57
|
+
srcExclude: ['**/README.md', '**/TODO.md'],
|
|
58
|
+
|
|
59
|
+
// Output directory
|
|
60
|
+
outDir: './.vitepress/dist',
|
|
61
|
+
|
|
62
|
+
// Cache directory
|
|
63
|
+
cacheDir: './.vitepress/cache',
|
|
64
|
+
|
|
65
|
+
// Clean URLs without .html extension (requires server support)
|
|
66
|
+
cleanUrls: true,
|
|
67
|
+
|
|
68
|
+
// Ignore dead links during build
|
|
69
|
+
ignoreDeadLinks: true,
|
|
70
|
+
// Or specific patterns:
|
|
71
|
+
ignoreDeadLinks: ['/playground', /^https?:\/\/localhost/],
|
|
72
|
+
|
|
73
|
+
// Get last updated timestamp from git
|
|
74
|
+
lastUpdated: true
|
|
75
|
+
})
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Route Rewrites
|
|
79
|
+
|
|
80
|
+
Map source paths to different output paths:
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
export default defineConfig({
|
|
84
|
+
rewrites: {
|
|
85
|
+
// Static mapping
|
|
86
|
+
'packages/pkg-a/src/index.md': 'pkg-a/index.md',
|
|
87
|
+
|
|
88
|
+
// Dynamic parameters
|
|
89
|
+
'packages/:pkg/src/:slug*': ':pkg/:slug*'
|
|
90
|
+
}
|
|
91
|
+
})
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Appearance (Dark Mode)
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
export default defineConfig({
|
|
98
|
+
appearance: true, // Enable toggle (default)
|
|
99
|
+
appearance: 'dark', // Dark by default
|
|
100
|
+
appearance: 'force-dark', // Always dark, no toggle
|
|
101
|
+
appearance: 'force-auto', // Always follow system preference
|
|
102
|
+
appearance: false // Disable dark mode
|
|
103
|
+
})
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Vite & Vue Configuration
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
export default defineConfig({
|
|
110
|
+
// Pass options to Vite
|
|
111
|
+
vite: {
|
|
112
|
+
plugins: [],
|
|
113
|
+
resolve: { alias: {} },
|
|
114
|
+
css: { preprocessorOptions: {} }
|
|
115
|
+
},
|
|
116
|
+
|
|
117
|
+
// Pass options to @vitejs/plugin-vue
|
|
118
|
+
vue: {
|
|
119
|
+
template: { compilerOptions: {} }
|
|
120
|
+
},
|
|
121
|
+
|
|
122
|
+
// Configure markdown-it
|
|
123
|
+
markdown: {
|
|
124
|
+
lineNumbers: true,
|
|
125
|
+
toc: { level: [1, 2, 3] },
|
|
126
|
+
math: true, // Requires markdown-it-mathjax3
|
|
127
|
+
container: {
|
|
128
|
+
tipLabel: 'TIP',
|
|
129
|
+
warningLabel: 'WARNING',
|
|
130
|
+
dangerLabel: 'DANGER'
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
})
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Build Hooks
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
export default defineConfig({
|
|
140
|
+
// Transform page data
|
|
141
|
+
transformPageData(pageData, { siteConfig }) {
|
|
142
|
+
pageData.frontmatter.head ??= []
|
|
143
|
+
pageData.frontmatter.head.push([
|
|
144
|
+
'meta', { name: 'og:title', content: pageData.title }
|
|
145
|
+
])
|
|
146
|
+
},
|
|
147
|
+
|
|
148
|
+
// Transform head before generating each page
|
|
149
|
+
async transformHead(context) {
|
|
150
|
+
return [['meta', { name: 'custom', content: context.page }]]
|
|
151
|
+
},
|
|
152
|
+
|
|
153
|
+
// After build completes
|
|
154
|
+
async buildEnd(siteConfig) {
|
|
155
|
+
// Generate sitemap, RSS, etc.
|
|
156
|
+
}
|
|
157
|
+
})
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Dynamic Config
|
|
161
|
+
|
|
162
|
+
For async configuration:
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
export default async () => {
|
|
166
|
+
const data = await fetch('https://api.example.com/data').then(r => r.json())
|
|
167
|
+
|
|
168
|
+
return defineConfig({
|
|
169
|
+
title: data.title,
|
|
170
|
+
themeConfig: {
|
|
171
|
+
sidebar: data.sidebar
|
|
172
|
+
}
|
|
173
|
+
})
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## Key Points
|
|
178
|
+
|
|
179
|
+
- Config file supports `.js`, `.ts`, `.mjs`, `.mts` extensions
|
|
180
|
+
- Use `defineConfig` for TypeScript support
|
|
181
|
+
- `base` must start and end with `/` for sub-path deployments
|
|
182
|
+
- `srcDir` separates source files from project root
|
|
183
|
+
- Build hooks enable custom transformations and post-processing
|
|
184
|
+
|
|
185
|
+
<!--
|
|
186
|
+
Source references:
|
|
187
|
+
- https://vitepress.dev/reference/site-config
|
|
188
|
+
- https://vitepress.dev/guide/getting-started
|
|
189
|
+
-->
|
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-markdown
|
|
3
|
+
description: Markdown extensions including frontmatter, custom containers, tables, anchors, and file includes
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Markdown Extensions
|
|
7
|
+
|
|
8
|
+
VitePress extends standard markdown with additional features for documentation.
|
|
9
|
+
|
|
10
|
+
## Frontmatter
|
|
11
|
+
|
|
12
|
+
YAML metadata at the top of markdown files:
|
|
13
|
+
|
|
14
|
+
```md
|
|
15
|
+
---
|
|
16
|
+
title: Page Title
|
|
17
|
+
description: Page description for SEO
|
|
18
|
+
layout: doc
|
|
19
|
+
outline: [2, 3]
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# Content starts here
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Access frontmatter in templates:
|
|
26
|
+
|
|
27
|
+
```md
|
|
28
|
+
# {{ $frontmatter.title }}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Or in script:
|
|
32
|
+
|
|
33
|
+
```vue
|
|
34
|
+
<script setup>
|
|
35
|
+
import { useData } from 'vitepress'
|
|
36
|
+
const { frontmatter } = useData()
|
|
37
|
+
</script>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Custom Containers
|
|
41
|
+
|
|
42
|
+
Styled callout blocks:
|
|
43
|
+
|
|
44
|
+
```md
|
|
45
|
+
::: info
|
|
46
|
+
This is an info box.
|
|
47
|
+
:::
|
|
48
|
+
|
|
49
|
+
::: tip
|
|
50
|
+
This is a tip.
|
|
51
|
+
:::
|
|
52
|
+
|
|
53
|
+
::: warning
|
|
54
|
+
This is a warning.
|
|
55
|
+
:::
|
|
56
|
+
|
|
57
|
+
::: danger
|
|
58
|
+
This is a dangerous warning.
|
|
59
|
+
:::
|
|
60
|
+
|
|
61
|
+
::: details Click to expand
|
|
62
|
+
Hidden content here.
|
|
63
|
+
:::
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Custom titles:
|
|
67
|
+
|
|
68
|
+
```md
|
|
69
|
+
::: danger STOP
|
|
70
|
+
Do not proceed!
|
|
71
|
+
:::
|
|
72
|
+
|
|
73
|
+
::: details Click me {open}
|
|
74
|
+
Open by default with {open} attribute.
|
|
75
|
+
:::
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## GitHub-flavored Alerts
|
|
79
|
+
|
|
80
|
+
Alternative syntax using blockquotes:
|
|
81
|
+
|
|
82
|
+
```md
|
|
83
|
+
> [!NOTE]
|
|
84
|
+
> Highlights information users should know.
|
|
85
|
+
|
|
86
|
+
> [!TIP]
|
|
87
|
+
> Optional information for success.
|
|
88
|
+
|
|
89
|
+
> [!WARNING]
|
|
90
|
+
> Critical content requiring attention.
|
|
91
|
+
|
|
92
|
+
> [!CAUTION]
|
|
93
|
+
> Negative potential consequences.
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Header Anchors
|
|
97
|
+
|
|
98
|
+
Headers get automatic anchor links. Custom anchors:
|
|
99
|
+
|
|
100
|
+
```md
|
|
101
|
+
# My Heading {#custom-anchor}
|
|
102
|
+
|
|
103
|
+
[Link to heading](#custom-anchor)
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Table of Contents
|
|
107
|
+
|
|
108
|
+
Generate a TOC with:
|
|
109
|
+
|
|
110
|
+
```md
|
|
111
|
+
[[toc]]
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## GitHub-Style Tables
|
|
115
|
+
|
|
116
|
+
```md
|
|
117
|
+
| Feature | Status |
|
|
118
|
+
|---------|--------|
|
|
119
|
+
| SSR | ✅ |
|
|
120
|
+
| HMR | ✅ |
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Emoji
|
|
124
|
+
|
|
125
|
+
Use shortcodes:
|
|
126
|
+
|
|
127
|
+
```md
|
|
128
|
+
:tada: :rocket: :100:
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## File Includes
|
|
132
|
+
|
|
133
|
+
Include content from other files:
|
|
134
|
+
|
|
135
|
+
```md
|
|
136
|
+
<!--@include: ./shared/header.md-->
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
With line ranges:
|
|
140
|
+
|
|
141
|
+
```md
|
|
142
|
+
<!--@include: ./code.md{3,10}--> <!-- Lines 3-10 -->
|
|
143
|
+
<!--@include: ./code.md{3,}--> <!-- From line 3 -->
|
|
144
|
+
<!--@include: ./code.md{,10}--> <!-- Up to line 10 -->
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
With regions:
|
|
148
|
+
|
|
149
|
+
```md
|
|
150
|
+
<!-- In parts/basics.md -->
|
|
151
|
+
<!-- #region usage -->
|
|
152
|
+
Usage content here
|
|
153
|
+
<!-- #endregion usage -->
|
|
154
|
+
|
|
155
|
+
<!-- Include just that region -->
|
|
156
|
+
<!--@include: ./parts/basics.md#usage-->
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Code Snippet Import
|
|
160
|
+
|
|
161
|
+
Import code from files:
|
|
162
|
+
|
|
163
|
+
```md
|
|
164
|
+
<<< @/snippets/example.js
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
With line highlighting:
|
|
168
|
+
|
|
169
|
+
```md
|
|
170
|
+
<<< @/snippets/example.js{2,4-6}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
With language override:
|
|
174
|
+
|
|
175
|
+
```md
|
|
176
|
+
<<< @/snippets/example.cs{1,2 c#:line-numbers}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Import specific region:
|
|
180
|
+
|
|
181
|
+
```md
|
|
182
|
+
<<< @/snippets/example.js#regionName{1,2}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## Code Groups
|
|
186
|
+
|
|
187
|
+
Tab groups for code variants:
|
|
188
|
+
|
|
189
|
+
````md
|
|
190
|
+
::: code-group
|
|
191
|
+
|
|
192
|
+
```js [config.js]
|
|
193
|
+
export default { /* ... */ }
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
```ts [config.ts]
|
|
197
|
+
export default defineConfig({ /* ... */ })
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
:::
|
|
201
|
+
````
|
|
202
|
+
|
|
203
|
+
Import files in code groups:
|
|
204
|
+
|
|
205
|
+
```md
|
|
206
|
+
::: code-group
|
|
207
|
+
|
|
208
|
+
<<< @/snippets/config.js
|
|
209
|
+
<<< @/snippets/config.ts
|
|
210
|
+
|
|
211
|
+
:::
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
## Math Equations
|
|
215
|
+
|
|
216
|
+
Requires setup:
|
|
217
|
+
|
|
218
|
+
```bash
|
|
219
|
+
npm add -D markdown-it-mathjax3@^4
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
```ts
|
|
223
|
+
// .vitepress/config.ts
|
|
224
|
+
export default {
|
|
225
|
+
markdown: {
|
|
226
|
+
math: true
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
Then use LaTeX:
|
|
232
|
+
|
|
233
|
+
```md
|
|
234
|
+
Inline: $E = mc^2$
|
|
235
|
+
|
|
236
|
+
Block:
|
|
237
|
+
$$
|
|
238
|
+
\frac{-b \pm \sqrt{b^2-4ac}}{2a}
|
|
239
|
+
$$
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
## Image Lazy Loading
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
export default {
|
|
246
|
+
markdown: {
|
|
247
|
+
image: {
|
|
248
|
+
lazyLoading: true
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
## Raw Container
|
|
255
|
+
|
|
256
|
+
Prevent VitePress style conflicts:
|
|
257
|
+
|
|
258
|
+
```md
|
|
259
|
+
::: raw
|
|
260
|
+
<CustomComponent />
|
|
261
|
+
:::
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
## Key Points
|
|
265
|
+
|
|
266
|
+
- Frontmatter supports YAML or JSON format
|
|
267
|
+
- Custom containers support info, tip, warning, danger, details
|
|
268
|
+
- `[[toc]]` generates table of contents
|
|
269
|
+
- `@` in imports refers to source root (or `srcDir` if configured)
|
|
270
|
+
- Code groups create tabbed code blocks
|
|
271
|
+
- Math support requires markdown-it-mathjax3 package
|
|
272
|
+
|
|
273
|
+
<!--
|
|
274
|
+
Source references:
|
|
275
|
+
- https://vitepress.dev/guide/markdown
|
|
276
|
+
- https://vitepress.dev/guide/frontmatter
|
|
277
|
+
-->
|