ads-fe 0.0.1
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/README.md +99 -0
- package/dist/cli.js +545 -0
- package/dist/meta.js +93 -0
- package/package.json +43 -0
- package/skill.md +66 -0
- package/skills/core/SKILL.md +66 -0
- package/skills/core/references/app-development.md +45 -0
- package/skills/core/references/git.md +66 -0
- package/skills/core/references/monorepo.md +124 -0
- package/skills/element-plus-vue3/LICENSE.md +405 -0
- package/skills/element-plus-vue3/LICENSE.txt +202 -0
- package/skills/element-plus-vue3/SKILL.md +218 -0
- package/skills/element-plus-vue3/SYNC.md +5 -0
- package/skills/element-plus-vue3/api/component-api.md +94 -0
- package/skills/element-plus-vue3/api/global-config.md +89 -0
- package/skills/element-plus-vue3/api/props-and-events.md +101 -0
- package/skills/element-plus-vue3/examples/components/button.md +99 -0
- package/skills/element-plus-vue3/examples/components/date-picker.md +115 -0
- package/skills/element-plus-vue3/examples/components/dialog.md +106 -0
- package/skills/element-plus-vue3/examples/components/form.md +127 -0
- package/skills/element-plus-vue3/examples/components/input.md +123 -0
- package/skills/element-plus-vue3/examples/components/message.md +93 -0
- package/skills/element-plus-vue3/examples/components/overview.md +59 -0
- package/skills/element-plus-vue3/examples/components/select.md +133 -0
- package/skills/element-plus-vue3/examples/components/table.md +166 -0
- package/skills/element-plus-vue3/examples/guide/design.md +68 -0
- package/skills/element-plus-vue3/examples/guide/global-config.md +95 -0
- package/skills/element-plus-vue3/examples/guide/i18n.md +95 -0
- package/skills/element-plus-vue3/examples/guide/installation.md +110 -0
- package/skills/element-plus-vue3/examples/guide/quick-start.md +103 -0
- package/skills/element-plus-vue3/examples/guide/theme.md +78 -0
- package/skills/element-plus-vue3/templates/component-usage.md +92 -0
- package/skills/element-plus-vue3/templates/installation.md +82 -0
- package/skills/element-plus-vue3/templates/project-setup.md +83 -0
- package/skills/node/LICENSE.md +21 -0
- package/skills/node/SKILL.md +94 -0
- package/skills/node/SYNC.md +5 -0
- package/skills/node/rules/assets/graceful-server.test.ts +88 -0
- package/skills/node/rules/assets/graceful-server.ts +80 -0
- package/skills/node/rules/async-patterns.md +136 -0
- package/skills/node/rules/caching.md +198 -0
- package/skills/node/rules/environment.md +253 -0
- package/skills/node/rules/error-handling.md +164 -0
- package/skills/node/rules/flaky-tests.md +439 -0
- package/skills/node/rules/graceful-shutdown.md +204 -0
- package/skills/node/rules/logging.md +205 -0
- package/skills/node/rules/modules.md +105 -0
- package/skills/node/rules/node-modules-exploration.md +172 -0
- package/skills/node/rules/performance.md +130 -0
- package/skills/node/rules/profiling.md +183 -0
- package/skills/node/rules/streams.md +213 -0
- package/skills/node/rules/stuck-processes-and-tests.md +124 -0
- package/skills/node/rules/testing.md +218 -0
- package/skills/node/rules/typescript.md +262 -0
- package/skills/node/tile.json +11 -0
- package/skills/nuxt/GENERATION.md +5 -0
- package/skills/nuxt/LICENSE.md +21 -0
- package/skills/nuxt/SKILL.md +55 -0
- package/skills/nuxt/SYNC.md +5 -0
- package/skills/nuxt/references/advanced-hooks.md +289 -0
- package/skills/nuxt/references/advanced-layers.md +299 -0
- package/skills/nuxt/references/advanced-module-authoring.md +554 -0
- package/skills/nuxt/references/best-practices-data-fetching.md +357 -0
- package/skills/nuxt/references/best-practices-ssr.md +355 -0
- package/skills/nuxt/references/core-cli.md +263 -0
- package/skills/nuxt/references/core-config.md +162 -0
- package/skills/nuxt/references/core-data-fetching.md +236 -0
- package/skills/nuxt/references/core-deployment.md +224 -0
- package/skills/nuxt/references/core-directory-structure.md +269 -0
- package/skills/nuxt/references/core-modules.md +292 -0
- package/skills/nuxt/references/core-routing.md +226 -0
- package/skills/nuxt/references/features-components-autoimport.md +328 -0
- package/skills/nuxt/references/features-components.md +264 -0
- package/skills/nuxt/references/features-composables.md +276 -0
- package/skills/nuxt/references/features-server.md +265 -0
- package/skills/nuxt/references/features-state.md +194 -0
- package/skills/nuxt/references/rendering-modes.md +237 -0
- package/skills/pinia/GENERATION.md +5 -0
- package/skills/pinia/LICENSE.md +21 -0
- package/skills/pinia/SKILL.md +59 -0
- package/skills/pinia/SYNC.md +5 -0
- package/skills/pinia/references/advanced-hmr.md +61 -0
- package/skills/pinia/references/advanced-nuxt.md +119 -0
- package/skills/pinia/references/advanced-ssr.md +121 -0
- package/skills/pinia/references/best-practices-outside-component.md +115 -0
- package/skills/pinia/references/best-practices-testing.md +212 -0
- package/skills/pinia/references/core-stores.md +389 -0
- package/skills/pinia/references/features-composables.md +114 -0
- package/skills/pinia/references/features-composing-stores.md +134 -0
- package/skills/pinia/references/features-plugins.md +203 -0
- package/skills/pnpm/GENERATION.md +5 -0
- package/skills/pnpm/LICENSE.md +21 -0
- package/skills/pnpm/SKILL.md +42 -0
- package/skills/pnpm/SYNC.md +5 -0
- package/skills/pnpm/references/best-practices-ci.md +285 -0
- package/skills/pnpm/references/best-practices-migration.md +291 -0
- package/skills/pnpm/references/best-practices-performance.md +284 -0
- package/skills/pnpm/references/core-cli.md +229 -0
- package/skills/pnpm/references/core-config.md +188 -0
- package/skills/pnpm/references/core-store.md +179 -0
- package/skills/pnpm/references/core-workspaces.md +205 -0
- package/skills/pnpm/references/features-aliases.md +168 -0
- package/skills/pnpm/references/features-catalogs.md +159 -0
- package/skills/pnpm/references/features-hooks.md +233 -0
- package/skills/pnpm/references/features-overrides.md +184 -0
- package/skills/pnpm/references/features-patches.md +201 -0
- package/skills/pnpm/references/features-peer-deps.md +250 -0
- package/skills/slidev/LICENSE.md +21 -0
- package/skills/slidev/README.md +61 -0
- package/skills/slidev/SKILL.md +189 -0
- package/skills/slidev/SYNC.md +5 -0
- package/skills/slidev/references/animation-click-marker.md +37 -0
- package/skills/slidev/references/animation-drawing.md +68 -0
- package/skills/slidev/references/animation-rough-marker.md +53 -0
- package/skills/slidev/references/api-slide-hooks.md +37 -0
- package/skills/slidev/references/build-og-image.md +36 -0
- package/skills/slidev/references/build-pdf.md +40 -0
- package/skills/slidev/references/build-remote-assets.md +34 -0
- package/skills/slidev/references/build-seo-meta.md +43 -0
- package/skills/slidev/references/code-groups.md +64 -0
- package/skills/slidev/references/code-import-snippet.md +55 -0
- package/skills/slidev/references/code-line-highlighting.md +50 -0
- package/skills/slidev/references/code-line-numbers.md +46 -0
- package/skills/slidev/references/code-magic-move.md +57 -0
- package/skills/slidev/references/code-max-height.md +37 -0
- package/skills/slidev/references/code-twoslash.md +42 -0
- package/skills/slidev/references/core-animations.md +196 -0
- package/skills/slidev/references/core-cli.md +140 -0
- package/skills/slidev/references/core-components.md +197 -0
- package/skills/slidev/references/core-exporting.md +148 -0
- package/skills/slidev/references/core-frontmatter.md +195 -0
- package/skills/slidev/references/core-global-context.md +155 -0
- package/skills/slidev/references/core-headmatter.md +188 -0
- package/skills/slidev/references/core-hosting.md +152 -0
- package/skills/slidev/references/core-layouts.md +286 -0
- package/skills/slidev/references/core-syntax.md +155 -0
- package/skills/slidev/references/diagram-latex.md +55 -0
- package/skills/slidev/references/diagram-mermaid.md +44 -0
- package/skills/slidev/references/diagram-plantuml.md +45 -0
- package/skills/slidev/references/editor-monaco-run.md +44 -0
- package/skills/slidev/references/editor-monaco-write.md +24 -0
- package/skills/slidev/references/editor-monaco.md +50 -0
- package/skills/slidev/references/editor-prettier.md +40 -0
- package/skills/slidev/references/editor-side.md +23 -0
- package/skills/slidev/references/editor-vscode.md +55 -0
- package/skills/slidev/references/layout-canvas-size.md +25 -0
- package/skills/slidev/references/layout-draggable.md +57 -0
- package/skills/slidev/references/layout-global-layers.md +50 -0
- package/skills/slidev/references/layout-slots.md +75 -0
- package/skills/slidev/references/layout-transform.md +33 -0
- package/skills/slidev/references/layout-zoom.md +39 -0
- package/skills/slidev/references/presenter-notes-ruby.md +35 -0
- package/skills/slidev/references/presenter-recording.md +30 -0
- package/skills/slidev/references/presenter-remote.md +40 -0
- package/skills/slidev/references/presenter-timer.md +34 -0
- package/skills/slidev/references/style-direction.md +34 -0
- package/skills/slidev/references/style-icons.md +46 -0
- package/skills/slidev/references/style-scoped.md +50 -0
- package/skills/slidev/references/syntax-block-frontmatter.md +39 -0
- package/skills/slidev/references/syntax-comark.md +51 -0
- package/skills/slidev/references/syntax-frontmatter-merging.md +49 -0
- package/skills/slidev/references/syntax-importing-slides.md +60 -0
- package/skills/slidev/references/tool-eject-theme.md +27 -0
- package/skills/tsdown/LICENSE.md +22 -0
- package/skills/tsdown/README.md +77 -0
- package/skills/tsdown/SKILL.md +416 -0
- package/skills/tsdown/SYNC.md +5 -0
- package/skills/tsdown/references/README.md +139 -0
- package/skills/tsdown/references/advanced-benchmark.md +8 -0
- package/skills/tsdown/references/advanced-ci.md +89 -0
- package/skills/tsdown/references/advanced-hooks.md +363 -0
- package/skills/tsdown/references/advanced-plugins.md +381 -0
- package/skills/tsdown/references/advanced-programmatic.md +378 -0
- package/skills/tsdown/references/advanced-rolldown-options.md +117 -0
- package/skills/tsdown/references/guide-getting-started.md +183 -0
- package/skills/tsdown/references/guide-introduction.md +42 -0
- package/skills/tsdown/references/guide-migrate-from-tsup.md +199 -0
- package/skills/tsdown/references/option-cjs-default.md +98 -0
- package/skills/tsdown/references/option-cleaning.md +275 -0
- package/skills/tsdown/references/option-config-file.md +291 -0
- package/skills/tsdown/references/option-css.md +301 -0
- package/skills/tsdown/references/option-dependencies.md +385 -0
- package/skills/tsdown/references/option-dts.md +251 -0
- package/skills/tsdown/references/option-entry.md +211 -0
- package/skills/tsdown/references/option-exe.md +120 -0
- package/skills/tsdown/references/option-lint.md +127 -0
- package/skills/tsdown/references/option-log-level.md +91 -0
- package/skills/tsdown/references/option-minification.md +177 -0
- package/skills/tsdown/references/option-output-directory.md +272 -0
- package/skills/tsdown/references/option-output-format.md +183 -0
- package/skills/tsdown/references/option-package-exports.md +320 -0
- package/skills/tsdown/references/option-platform.md +256 -0
- package/skills/tsdown/references/option-root.md +88 -0
- package/skills/tsdown/references/option-shims.md +299 -0
- package/skills/tsdown/references/option-sourcemap.md +301 -0
- package/skills/tsdown/references/option-target.md +222 -0
- package/skills/tsdown/references/option-tree-shaking.md +335 -0
- package/skills/tsdown/references/option-unbundle.md +310 -0
- package/skills/tsdown/references/option-watch-mode.md +261 -0
- package/skills/tsdown/references/recipe-react.md +338 -0
- package/skills/tsdown/references/recipe-solid.md +42 -0
- package/skills/tsdown/references/recipe-svelte.md +54 -0
- package/skills/tsdown/references/recipe-vue.md +387 -0
- package/skills/tsdown/references/recipe-wasm.md +125 -0
- package/skills/tsdown/references/reference-cli.md +472 -0
- package/skills/turborepo/LICENSE.md +7 -0
- package/skills/turborepo/SKILL.md +951 -0
- package/skills/turborepo/SYNC.md +5 -0
- package/skills/turborepo/command/turborepo.md +70 -0
- package/skills/turborepo/references/best-practices/RULE.md +241 -0
- package/skills/turborepo/references/best-practices/dependencies.md +246 -0
- package/skills/turborepo/references/best-practices/packages.md +335 -0
- package/skills/turborepo/references/best-practices/structure.md +297 -0
- package/skills/turborepo/references/boundaries/RULE.md +126 -0
- package/skills/turborepo/references/caching/RULE.md +153 -0
- package/skills/turborepo/references/caching/gotchas.md +190 -0
- package/skills/turborepo/references/caching/remote-cache.md +127 -0
- package/skills/turborepo/references/ci/RULE.md +79 -0
- package/skills/turborepo/references/ci/github-actions.md +162 -0
- package/skills/turborepo/references/ci/patterns.md +145 -0
- package/skills/turborepo/references/ci/vercel.md +103 -0
- package/skills/turborepo/references/cli/RULE.md +100 -0
- package/skills/turborepo/references/cli/commands.md +297 -0
- package/skills/turborepo/references/configuration/RULE.md +235 -0
- package/skills/turborepo/references/configuration/global-options.md +239 -0
- package/skills/turborepo/references/configuration/gotchas.md +368 -0
- package/skills/turborepo/references/configuration/tasks.md +325 -0
- package/skills/turborepo/references/environment/RULE.md +123 -0
- package/skills/turborepo/references/environment/gotchas.md +175 -0
- package/skills/turborepo/references/environment/modes.md +101 -0
- package/skills/turborepo/references/filtering/RULE.md +148 -0
- package/skills/turborepo/references/filtering/patterns.md +152 -0
- package/skills/turborepo/references/watch/RULE.md +99 -0
- package/skills/vite/GENERATION.md +5 -0
- package/skills/vite/LICENSE.md +21 -0
- package/skills/vite/SKILL.md +72 -0
- package/skills/vite/SYNC.md +5 -0
- package/skills/vite/references/build-and-ssr.md +164 -0
- package/skills/vite/references/core-config.md +162 -0
- package/skills/vite/references/core-features.md +205 -0
- package/skills/vite/references/core-plugin-api.md +235 -0
- package/skills/vite/references/environment-api.md +108 -0
- package/skills/vite/references/rolldown-migration.md +157 -0
- package/skills/vitepress/GENERATION.md +5 -0
- package/skills/vitepress/LICENSE.md +21 -0
- package/skills/vitepress/SKILL.md +65 -0
- package/skills/vitepress/SYNC.md +5 -0
- package/skills/vitepress/references/advanced-i18n.md +299 -0
- package/skills/vitepress/references/advanced-ssr.md +228 -0
- package/skills/vitepress/references/core-cli.md +119 -0
- package/skills/vitepress/references/core-config.md +189 -0
- package/skills/vitepress/references/core-markdown.md +277 -0
- package/skills/vitepress/references/core-routing.md +169 -0
- package/skills/vitepress/references/features-code-blocks.md +243 -0
- package/skills/vitepress/references/features-data-loading.md +220 -0
- package/skills/vitepress/references/features-dynamic-routes.md +235 -0
- package/skills/vitepress/references/features-vue.md +224 -0
- package/skills/vitepress/references/recipes-deploy.md +240 -0
- package/skills/vitepress/references/theme-config.md +315 -0
- package/skills/vitepress/references/theme-custom.md +269 -0
- package/skills/vitepress/references/theme-customization.md +290 -0
- package/skills/vitest/GENERATION.md +5 -0
- package/skills/vitest/LICENSE.md +21 -0
- package/skills/vitest/SKILL.md +52 -0
- package/skills/vitest/SYNC.md +5 -0
- package/skills/vitest/references/advanced-environments.md +264 -0
- package/skills/vitest/references/advanced-projects.md +300 -0
- package/skills/vitest/references/advanced-type-testing.md +237 -0
- package/skills/vitest/references/advanced-vi.md +249 -0
- package/skills/vitest/references/core-cli.md +166 -0
- package/skills/vitest/references/core-config.md +174 -0
- package/skills/vitest/references/core-describe.md +193 -0
- package/skills/vitest/references/core-expect.md +219 -0
- package/skills/vitest/references/core-hooks.md +244 -0
- package/skills/vitest/references/core-test-api.md +233 -0
- package/skills/vitest/references/features-concurrency.md +250 -0
- package/skills/vitest/references/features-context.md +238 -0
- package/skills/vitest/references/features-coverage.md +207 -0
- package/skills/vitest/references/features-filtering.md +211 -0
- package/skills/vitest/references/features-mocking.md +265 -0
- package/skills/vitest/references/features-snapshots.md +207 -0
- package/skills/vue/GENERATION.md +5 -0
- package/skills/vue/LICENSE.md +21 -0
- package/skills/vue/SKILL.md +84 -0
- package/skills/vue/SYNC.md +5 -0
- package/skills/vue/references/advanced-patterns.md +314 -0
- package/skills/vue/references/core-new-apis.md +264 -0
- package/skills/vue/references/script-setup-macros.md +204 -0
- package/skills/vue-best-practices/LICENSE.md +21 -0
- package/skills/vue-best-practices/SKILL.md +154 -0
- package/skills/vue-best-practices/SYNC.md +5 -0
- package/skills/vue-best-practices/references/animation-class-based-technique.md +254 -0
- package/skills/vue-best-practices/references/animation-state-driven-technique.md +291 -0
- package/skills/vue-best-practices/references/component-async.md +97 -0
- package/skills/vue-best-practices/references/component-data-flow.md +307 -0
- package/skills/vue-best-practices/references/component-fallthrough-attrs.md +174 -0
- package/skills/vue-best-practices/references/component-keep-alive.md +137 -0
- package/skills/vue-best-practices/references/component-slots.md +216 -0
- package/skills/vue-best-practices/references/component-suspense.md +228 -0
- package/skills/vue-best-practices/references/component-teleport.md +108 -0
- package/skills/vue-best-practices/references/component-transition-group.md +128 -0
- package/skills/vue-best-practices/references/component-transition.md +125 -0
- package/skills/vue-best-practices/references/composables.md +290 -0
- package/skills/vue-best-practices/references/directives.md +162 -0
- package/skills/vue-best-practices/references/perf-avoid-component-abstraction-in-lists.md +159 -0
- package/skills/vue-best-practices/references/perf-v-once-v-memo-directives.md +182 -0
- package/skills/vue-best-practices/references/perf-virtualize-large-lists.md +187 -0
- package/skills/vue-best-practices/references/plugins.md +166 -0
- package/skills/vue-best-practices/references/reactivity.md +344 -0
- package/skills/vue-best-practices/references/render-functions.md +201 -0
- package/skills/vue-best-practices/references/sfc.md +310 -0
- package/skills/vue-best-practices/references/state-management.md +135 -0
- package/skills/vue-best-practices/references/updated-hook-performance.md +187 -0
- package/skills/vue-router-best-practices/LICENSE.md +21 -0
- package/skills/vue-router-best-practices/SKILL.md +23 -0
- package/skills/vue-router-best-practices/SYNC.md +5 -0
- package/skills/vue-router-best-practices/reference/router-beforeenter-no-param-trigger.md +167 -0
- package/skills/vue-router-best-practices/reference/router-beforerouteenter-no-this.md +176 -0
- package/skills/vue-router-best-practices/reference/router-guard-async-await-pattern.md +227 -0
- package/skills/vue-router-best-practices/reference/router-navigation-guard-infinite-loop.md +187 -0
- package/skills/vue-router-best-practices/reference/router-navigation-guard-next-deprecated.md +150 -0
- package/skills/vue-router-best-practices/reference/router-param-change-no-lifecycle.md +181 -0
- package/skills/vue-router-best-practices/reference/router-simple-routing-cleanup.md +209 -0
- package/skills/vue-router-best-practices/reference/router-use-vue-router-for-production.md +183 -0
- package/skills/vue-testing-best-practices/LICENSE.md +21 -0
- package/skills/vue-testing-best-practices/SKILL.md +29 -0
- package/skills/vue-testing-best-practices/SYNC.md +5 -0
- package/skills/vue-testing-best-practices/reference/async-component-testing.md +163 -0
- package/skills/vue-testing-best-practices/reference/teleport-testing-complexity.md +158 -0
- package/skills/vue-testing-best-practices/reference/testing-async-await-flushpromises.md +175 -0
- package/skills/vue-testing-best-practices/reference/testing-browser-vs-node-runners.md +208 -0
- package/skills/vue-testing-best-practices/reference/testing-component-blackbox-approach.md +144 -0
- package/skills/vue-testing-best-practices/reference/testing-composables-helper-wrapper.md +238 -0
- package/skills/vue-testing-best-practices/reference/testing-e2e-playwright-recommended.md +242 -0
- package/skills/vue-testing-best-practices/reference/testing-no-snapshot-only.md +197 -0
- package/skills/vue-testing-best-practices/reference/testing-pinia-store-setup.md +228 -0
- package/skills/vue-testing-best-practices/reference/testing-suspense-async-components.md +229 -0
- package/skills/vue-testing-best-practices/reference/testing-vitest-recommended-for-vue.md +204 -0
- package/skills/vueuse-functions/LICENSE.md +21 -0
- package/skills/vueuse-functions/SKILL.md +419 -0
- package/skills/vueuse-functions/SYNC.md +5 -0
- package/skills/vueuse-functions/references/computedAsync.md +195 -0
- package/skills/vueuse-functions/references/computedEager.md +62 -0
- package/skills/vueuse-functions/references/computedInject.md +137 -0
- package/skills/vueuse-functions/references/computedWithControl.md +98 -0
- package/skills/vueuse-functions/references/createEventHook.md +86 -0
- package/skills/vueuse-functions/references/createGenericProjection.md +25 -0
- package/skills/vueuse-functions/references/createGlobalState.md +95 -0
- package/skills/vueuse-functions/references/createInjectionState.md +226 -0
- package/skills/vueuse-functions/references/createProjection.md +31 -0
- package/skills/vueuse-functions/references/createRef.md +54 -0
- package/skills/vueuse-functions/references/createReusableTemplate.md +361 -0
- package/skills/vueuse-functions/references/createSharedComposable.md +42 -0
- package/skills/vueuse-functions/references/createTemplatePromise.md +306 -0
- package/skills/vueuse-functions/references/createUnrefFn.md +51 -0
- package/skills/vueuse-functions/references/extendRef.md +76 -0
- package/skills/vueuse-functions/references/from.md +80 -0
- package/skills/vueuse-functions/references/get.md +30 -0
- package/skills/vueuse-functions/references/injectLocal.md +35 -0
- package/skills/vueuse-functions/references/isDefined.md +31 -0
- package/skills/vueuse-functions/references/logicAnd.md +40 -0
- package/skills/vueuse-functions/references/logicNot.md +36 -0
- package/skills/vueuse-functions/references/logicOr.md +40 -0
- package/skills/vueuse-functions/references/makeDestructurable.md +41 -0
- package/skills/vueuse-functions/references/onClickOutside.md +228 -0
- package/skills/vueuse-functions/references/onElementRemoval.md +88 -0
- package/skills/vueuse-functions/references/onKeyStroke.md +212 -0
- package/skills/vueuse-functions/references/onLongPress.md +235 -0
- package/skills/vueuse-functions/references/onStartTyping.md +53 -0
- package/skills/vueuse-functions/references/provideLocal.md +37 -0
- package/skills/vueuse-functions/references/reactify.md +144 -0
- package/skills/vueuse-functions/references/reactifyObject.md +62 -0
- package/skills/vueuse-functions/references/reactiveComputed.md +34 -0
- package/skills/vueuse-functions/references/reactiveOmit.md +86 -0
- package/skills/vueuse-functions/references/reactivePick.md +106 -0
- package/skills/vueuse-functions/references/refAutoReset.md +46 -0
- package/skills/vueuse-functions/references/refDebounced.md +81 -0
- package/skills/vueuse-functions/references/refDefault.md +36 -0
- package/skills/vueuse-functions/references/refManualReset.md +48 -0
- package/skills/vueuse-functions/references/refThrottled.md +99 -0
- package/skills/vueuse-functions/references/refWithControl.md +146 -0
- package/skills/vueuse-functions/references/set.md +30 -0
- package/skills/vueuse-functions/references/syncRef.md +195 -0
- package/skills/vueuse-functions/references/syncRefs.md +128 -0
- package/skills/vueuse-functions/references/templateRef.md +86 -0
- package/skills/vueuse-functions/references/toObserver.md +38 -0
- package/skills/vueuse-functions/references/toReactive.md +41 -0
- package/skills/vueuse-functions/references/toRef.md +74 -0
- package/skills/vueuse-functions/references/toRefs.md +78 -0
- package/skills/vueuse-functions/references/tryOnBeforeMount.md +34 -0
- package/skills/vueuse-functions/references/tryOnBeforeUnmount.md +32 -0
- package/skills/vueuse-functions/references/tryOnMounted.md +34 -0
- package/skills/vueuse-functions/references/tryOnScopeDispose.md +31 -0
- package/skills/vueuse-functions/references/tryOnUnmounted.md +32 -0
- package/skills/vueuse-functions/references/unrefElement.md +54 -0
- package/skills/vueuse-functions/references/until.md +161 -0
- package/skills/vueuse-functions/references/useAbs.md +31 -0
- package/skills/vueuse-functions/references/useActiveElement.md +86 -0
- package/skills/vueuse-functions/references/useAnimate.md +180 -0
- package/skills/vueuse-functions/references/useArrayDifference.md +84 -0
- package/skills/vueuse-functions/references/useArrayEvery.md +59 -0
- package/skills/vueuse-functions/references/useArrayFilter.md +63 -0
- package/skills/vueuse-functions/references/useArrayFind.md +50 -0
- package/skills/vueuse-functions/references/useArrayFindIndex.md +59 -0
- package/skills/vueuse-functions/references/useArrayFindLast.md +52 -0
- package/skills/vueuse-functions/references/useArrayIncludes.md +63 -0
- package/skills/vueuse-functions/references/useArrayJoin.md +74 -0
- package/skills/vueuse-functions/references/useArrayMap.md +59 -0
- package/skills/vueuse-functions/references/useArrayReduce.md +81 -0
- package/skills/vueuse-functions/references/useArraySome.md +59 -0
- package/skills/vueuse-functions/references/useArrayUnique.md +76 -0
- package/skills/vueuse-functions/references/useAsyncQueue.md +136 -0
- package/skills/vueuse-functions/references/useAsyncState.md +185 -0
- package/skills/vueuse-functions/references/useAsyncValidator.md +70 -0
- package/skills/vueuse-functions/references/useAuth.md +123 -0
- package/skills/vueuse-functions/references/useAverage.md +36 -0
- package/skills/vueuse-functions/references/useAxios.md +325 -0
- package/skills/vueuse-functions/references/useBase64.md +136 -0
- package/skills/vueuse-functions/references/useBattery.md +80 -0
- package/skills/vueuse-functions/references/useBluetooth.md +174 -0
- package/skills/vueuse-functions/references/useBreakpoints.md +176 -0
- package/skills/vueuse-functions/references/useBroadcastChannel.md +73 -0
- package/skills/vueuse-functions/references/useBrowserLocation.md +56 -0
- package/skills/vueuse-functions/references/useCached.md +52 -0
- package/skills/vueuse-functions/references/useCeil.md +31 -0
- package/skills/vueuse-functions/references/useChangeCase.md +79 -0
- package/skills/vueuse-functions/references/useClamp.md +85 -0
- package/skills/vueuse-functions/references/useClipboard.md +122 -0
- package/skills/vueuse-functions/references/useClipboardItems.md +93 -0
- package/skills/vueuse-functions/references/useCloned.md +91 -0
- package/skills/vueuse-functions/references/useColorMode.md +172 -0
- package/skills/vueuse-functions/references/useConfirmDialog.md +159 -0
- package/skills/vueuse-functions/references/useCookies.md +162 -0
- package/skills/vueuse-functions/references/useCountdown.md +105 -0
- package/skills/vueuse-functions/references/useCounter.md +86 -0
- package/skills/vueuse-functions/references/useCssSupports.md +33 -0
- package/skills/vueuse-functions/references/useCssVar.md +50 -0
- package/skills/vueuse-functions/references/useCurrentElement.md +61 -0
- package/skills/vueuse-functions/references/useCycleList.md +75 -0
- package/skills/vueuse-functions/references/useDark.md +142 -0
- package/skills/vueuse-functions/references/useDateFormat.md +145 -0
- package/skills/vueuse-functions/references/useDebounceFn.md +100 -0
- package/skills/vueuse-functions/references/useDebouncedRefHistory.md +40 -0
- package/skills/vueuse-functions/references/useDeviceMotion.md +80 -0
- package/skills/vueuse-functions/references/useDeviceOrientation.md +64 -0
- package/skills/vueuse-functions/references/useDevicePixelRatio.md +47 -0
- package/skills/vueuse-functions/references/useDevicesList.md +89 -0
- package/skills/vueuse-functions/references/useDisplayMedia.md +67 -0
- package/skills/vueuse-functions/references/useDocumentVisibility.md +44 -0
- package/skills/vueuse-functions/references/useDraggable.md +289 -0
- package/skills/vueuse-functions/references/useDrauu.md +65 -0
- package/skills/vueuse-functions/references/useDropZone.md +83 -0
- package/skills/vueuse-functions/references/useElementBounding.md +131 -0
- package/skills/vueuse-functions/references/useElementByPoint.md +46 -0
- package/skills/vueuse-functions/references/useElementHover.md +79 -0
- package/skills/vueuse-functions/references/useElementSize.md +79 -0
- package/skills/vueuse-functions/references/useElementVisibility.md +163 -0
- package/skills/vueuse-functions/references/useEventBus.md +101 -0
- package/skills/vueuse-functions/references/useEventListener.md +226 -0
- package/skills/vueuse-functions/references/useEventSource.md +204 -0
- package/skills/vueuse-functions/references/useExtractedObservable.md +198 -0
- package/skills/vueuse-functions/references/useEyeDropper.md +72 -0
- package/skills/vueuse-functions/references/useFavicon.md +69 -0
- package/skills/vueuse-functions/references/useFetch.md +546 -0
- package/skills/vueuse-functions/references/useFileDialog.md +91 -0
- package/skills/vueuse-functions/references/useFileSystemAccess.md +161 -0
- package/skills/vueuse-functions/references/useFirestore.md +129 -0
- package/skills/vueuse-functions/references/useFloor.md +31 -0
- package/skills/vueuse-functions/references/useFocus.md +99 -0
- package/skills/vueuse-functions/references/useFocusTrap.md +245 -0
- package/skills/vueuse-functions/references/useFocusWithin.md +57 -0
- package/skills/vueuse-functions/references/useFps.md +28 -0
- package/skills/vueuse-functions/references/useFullscreen.md +74 -0
- package/skills/vueuse-functions/references/useFuse.md +75 -0
- package/skills/vueuse-functions/references/useGamepad.md +176 -0
- package/skills/vueuse-functions/references/useGeolocation.md +63 -0
- package/skills/vueuse-functions/references/useIDBKeyval.md +93 -0
- package/skills/vueuse-functions/references/useIdle.md +88 -0
- package/skills/vueuse-functions/references/useImage.md +90 -0
- package/skills/vueuse-functions/references/useInfiniteScroll.md +156 -0
- package/skills/vueuse-functions/references/useIntersectionObserver.md +117 -0
- package/skills/vueuse-functions/references/useInterval.md +112 -0
- package/skills/vueuse-functions/references/useIntervalFn.md +50 -0
- package/skills/vueuse-functions/references/useIpcRenderer.md +144 -0
- package/skills/vueuse-functions/references/useIpcRendererInvoke.md +58 -0
- package/skills/vueuse-functions/references/useIpcRendererOn.md +52 -0
- package/skills/vueuse-functions/references/useJwt.md +57 -0
- package/skills/vueuse-functions/references/useKeyModifier.md +87 -0
- package/skills/vueuse-functions/references/useLastChanged.md +63 -0
- package/skills/vueuse-functions/references/useLocalStorage.md +41 -0
- package/skills/vueuse-functions/references/useMagicKeys.md +245 -0
- package/skills/vueuse-functions/references/useManualRefHistory.md +204 -0
- package/skills/vueuse-functions/references/useMath.md +47 -0
- package/skills/vueuse-functions/references/useMax.md +36 -0
- package/skills/vueuse-functions/references/useMediaControls.md +201 -0
- package/skills/vueuse-functions/references/useMediaQuery.md +53 -0
- package/skills/vueuse-functions/references/useMemoize.md +175 -0
- package/skills/vueuse-functions/references/useMemory.md +70 -0
- package/skills/vueuse-functions/references/useMin.md +36 -0
- package/skills/vueuse-functions/references/useMounted.md +38 -0
- package/skills/vueuse-functions/references/useMouse.md +113 -0
- package/skills/vueuse-functions/references/useMouseInElement.md +132 -0
- package/skills/vueuse-functions/references/useMousePressed.md +116 -0
- package/skills/vueuse-functions/references/useMutationObserver.md +60 -0
- package/skills/vueuse-functions/references/useNProgress.md +78 -0
- package/skills/vueuse-functions/references/useNavigatorLanguage.md +57 -0
- package/skills/vueuse-functions/references/useNetwork.md +106 -0
- package/skills/vueuse-functions/references/useNow.md +83 -0
- package/skills/vueuse-functions/references/useObjectUrl.md +55 -0
- package/skills/vueuse-functions/references/useObservable.md +91 -0
- package/skills/vueuse-functions/references/useOffsetPagination.md +199 -0
- package/skills/vueuse-functions/references/useOnline.md +41 -0
- package/skills/vueuse-functions/references/usePageLeave.md +43 -0
- package/skills/vueuse-functions/references/useParallax.md +58 -0
- package/skills/vueuse-functions/references/useParentElement.md +54 -0
- package/skills/vueuse-functions/references/usePerformanceObserver.md +48 -0
- package/skills/vueuse-functions/references/usePermission.md +78 -0
- package/skills/vueuse-functions/references/usePointer.md +91 -0
- package/skills/vueuse-functions/references/usePointerLock.md +59 -0
- package/skills/vueuse-functions/references/usePointerSwipe.md +80 -0
- package/skills/vueuse-functions/references/usePrecision.md +49 -0
- package/skills/vueuse-functions/references/usePreferredColorScheme.md +42 -0
- package/skills/vueuse-functions/references/usePreferredContrast.md +42 -0
- package/skills/vueuse-functions/references/usePreferredDark.md +41 -0
- package/skills/vueuse-functions/references/usePreferredLanguages.md +41 -0
- package/skills/vueuse-functions/references/usePreferredReducedMotion.md +42 -0
- package/skills/vueuse-functions/references/usePreferredReducedTransparency.md +42 -0
- package/skills/vueuse-functions/references/usePrevious.md +40 -0
- package/skills/vueuse-functions/references/useProjection.md +38 -0
- package/skills/vueuse-functions/references/useQRCode.md +53 -0
- package/skills/vueuse-functions/references/useRTDB.md +83 -0
- package/skills/vueuse-functions/references/useRafFn.md +68 -0
- package/skills/vueuse-functions/references/useRefHistory.md +285 -0
- package/skills/vueuse-functions/references/useResizeObserver.md +108 -0
- package/skills/vueuse-functions/references/useRound.md +31 -0
- package/skills/vueuse-functions/references/useRouteHash.md +27 -0
- package/skills/vueuse-functions/references/useRouteParams.md +38 -0
- package/skills/vueuse-functions/references/useRouteQuery.md +79 -0
- package/skills/vueuse-functions/references/useSSRWidth.md +47 -0
- package/skills/vueuse-functions/references/useScreenOrientation.md +98 -0
- package/skills/vueuse-functions/references/useScreenSafeArea.md +60 -0
- package/skills/vueuse-functions/references/useScriptTag.md +116 -0
- package/skills/vueuse-functions/references/useScroll.md +238 -0
- package/skills/vueuse-functions/references/useScrollLock.md +66 -0
- package/skills/vueuse-functions/references/useSessionStorage.md +41 -0
- package/skills/vueuse-functions/references/useShare.md +67 -0
- package/skills/vueuse-functions/references/useSortable.md +276 -0
- package/skills/vueuse-functions/references/useSorted.md +90 -0
- package/skills/vueuse-functions/references/useSpeechRecognition.md +90 -0
- package/skills/vueuse-functions/references/useSpeechSynthesis.md +101 -0
- package/skills/vueuse-functions/references/useStepper.md +137 -0
- package/skills/vueuse-functions/references/useStorage.md +278 -0
- package/skills/vueuse-functions/references/useStorageAsync.md +136 -0
- package/skills/vueuse-functions/references/useStyleTag.md +131 -0
- package/skills/vueuse-functions/references/useSubject.md +77 -0
- package/skills/vueuse-functions/references/useSubscription.md +33 -0
- package/skills/vueuse-functions/references/useSum.md +36 -0
- package/skills/vueuse-functions/references/useSupported.md +29 -0
- package/skills/vueuse-functions/references/useSwipe.md +75 -0
- package/skills/vueuse-functions/references/useTemplateRefsList.md +37 -0
- package/skills/vueuse-functions/references/useTextDirection.md +75 -0
- package/skills/vueuse-functions/references/useTextSelection.md +43 -0
- package/skills/vueuse-functions/references/useTextareaAutosize.md +94 -0
- package/skills/vueuse-functions/references/useThrottleFn.md +57 -0
- package/skills/vueuse-functions/references/useThrottledRefHistory.md +47 -0
- package/skills/vueuse-functions/references/useTimeAgo.md +154 -0
- package/skills/vueuse-functions/references/useTimeAgoIntl.md +117 -0
- package/skills/vueuse-functions/references/useTimeout.md +113 -0
- package/skills/vueuse-functions/references/useTimeoutFn.md +51 -0
- package/skills/vueuse-functions/references/useTimeoutPoll.md +47 -0
- package/skills/vueuse-functions/references/useTimestamp.md +93 -0
- package/skills/vueuse-functions/references/useTitle.md +115 -0
- package/skills/vueuse-functions/references/useToNumber.md +54 -0
- package/skills/vueuse-functions/references/useToString.md +34 -0
- package/skills/vueuse-functions/references/useToggle.md +103 -0
- package/skills/vueuse-functions/references/useTransition.md +265 -0
- package/skills/vueuse-functions/references/useTrunc.md +33 -0
- package/skills/vueuse-functions/references/useUrlSearchParams.md +121 -0
- package/skills/vueuse-functions/references/useUserMedia.md +96 -0
- package/skills/vueuse-functions/references/useVModel.md +182 -0
- package/skills/vueuse-functions/references/useVModels.md +67 -0
- package/skills/vueuse-functions/references/useVibrate.md +86 -0
- package/skills/vueuse-functions/references/useVirtualList.md +182 -0
- package/skills/vueuse-functions/references/useWakeLock.md +51 -0
- package/skills/vueuse-functions/references/useWebNotification.md +175 -0
- package/skills/vueuse-functions/references/useWebSocket.md +299 -0
- package/skills/vueuse-functions/references/useWebWorker.md +60 -0
- package/skills/vueuse-functions/references/useWebWorkerFn.md +102 -0
- package/skills/vueuse-functions/references/useWindowFocus.md +46 -0
- package/skills/vueuse-functions/references/useWindowScroll.md +46 -0
- package/skills/vueuse-functions/references/useWindowSize.md +78 -0
- package/skills/vueuse-functions/references/useZoomFactor.md +53 -0
- package/skills/vueuse-functions/references/useZoomLevel.md +53 -0
- package/skills/vueuse-functions/references/watchArray.md +53 -0
- package/skills/vueuse-functions/references/watchAtMost.md +63 -0
- package/skills/vueuse-functions/references/watchDebounced.md +101 -0
- package/skills/vueuse-functions/references/watchDeep.md +54 -0
- package/skills/vueuse-functions/references/watchExtractedObservable.md +192 -0
- package/skills/vueuse-functions/references/watchIgnorable.md +120 -0
- package/skills/vueuse-functions/references/watchImmediate.md +44 -0
- package/skills/vueuse-functions/references/watchOnce.md +41 -0
- package/skills/vueuse-functions/references/watchPausable.md +86 -0
- package/skills/vueuse-functions/references/watchThrottled.md +108 -0
- package/skills/vueuse-functions/references/watchTriggerable.md +98 -0
- package/skills/vueuse-functions/references/watchWithFilter.md +54 -0
- package/skills/vueuse-functions/references/whenever.md +108 -0
- package/skills/web-design-guidelines/SKILL.md +39 -0
- package/skills/web-design-guidelines/SYNC.md +5 -0
|
@@ -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
|
+
-->
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-dynamic-routes
|
|
3
|
+
description: Generate multiple pages from a single markdown template using paths loader files
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Dynamic Routes
|
|
7
|
+
|
|
8
|
+
Generate many pages from a single markdown file and dynamic data. Useful for blogs, package docs, or any data-driven pages.
|
|
9
|
+
|
|
10
|
+
## Basic Setup
|
|
11
|
+
|
|
12
|
+
Create a template file with parameter in brackets and a paths loader:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
.
|
|
16
|
+
└─ packages/
|
|
17
|
+
├─ [pkg].md # Route template
|
|
18
|
+
└─ [pkg].paths.js # Paths loader
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The paths loader exports a `paths` method returning route parameters:
|
|
22
|
+
|
|
23
|
+
```js
|
|
24
|
+
// packages/[pkg].paths.js
|
|
25
|
+
export default {
|
|
26
|
+
paths() {
|
|
27
|
+
return [
|
|
28
|
+
{ params: { pkg: 'foo' }},
|
|
29
|
+
{ params: { pkg: 'bar' }},
|
|
30
|
+
{ params: { pkg: 'baz' }}
|
|
31
|
+
]
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Generated pages:
|
|
37
|
+
- `/packages/foo.html`
|
|
38
|
+
- `/packages/bar.html`
|
|
39
|
+
- `/packages/baz.html`
|
|
40
|
+
|
|
41
|
+
## Multiple Parameters
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
.
|
|
45
|
+
└─ packages/
|
|
46
|
+
├─ [pkg]-[version].md
|
|
47
|
+
└─ [pkg]-[version].paths.js
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
```js
|
|
51
|
+
// packages/[pkg]-[version].paths.js
|
|
52
|
+
export default {
|
|
53
|
+
paths() {
|
|
54
|
+
return [
|
|
55
|
+
{ params: { pkg: 'foo', version: '1.0.0' }},
|
|
56
|
+
{ params: { pkg: 'foo', version: '2.0.0' }},
|
|
57
|
+
{ params: { pkg: 'bar', version: '1.0.0' }}
|
|
58
|
+
]
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Dynamic Path Generation
|
|
64
|
+
|
|
65
|
+
From local files:
|
|
66
|
+
|
|
67
|
+
```js
|
|
68
|
+
// packages/[pkg].paths.js
|
|
69
|
+
import fs from 'node:fs'
|
|
70
|
+
|
|
71
|
+
export default {
|
|
72
|
+
paths() {
|
|
73
|
+
return fs.readdirSync('packages').map(pkg => ({
|
|
74
|
+
params: { pkg }
|
|
75
|
+
}))
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
From remote API:
|
|
81
|
+
|
|
82
|
+
```js
|
|
83
|
+
// packages/[pkg].paths.js
|
|
84
|
+
export default {
|
|
85
|
+
async paths() {
|
|
86
|
+
const packages = await fetch('https://api.example.com/packages').then(r => r.json())
|
|
87
|
+
|
|
88
|
+
return packages.map(pkg => ({
|
|
89
|
+
params: {
|
|
90
|
+
pkg: pkg.name,
|
|
91
|
+
version: pkg.version
|
|
92
|
+
}
|
|
93
|
+
}))
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Accessing Params in Page
|
|
99
|
+
|
|
100
|
+
Template globals:
|
|
101
|
+
|
|
102
|
+
```md
|
|
103
|
+
<!-- packages/[pkg].md -->
|
|
104
|
+
# Package: {{ $params.pkg }}
|
|
105
|
+
|
|
106
|
+
Version: {{ $params.version }}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
In script:
|
|
110
|
+
|
|
111
|
+
```vue
|
|
112
|
+
<script setup>
|
|
113
|
+
import { useData } from 'vitepress'
|
|
114
|
+
const { params } = useData()
|
|
115
|
+
</script>
|
|
116
|
+
|
|
117
|
+
<template>
|
|
118
|
+
<h1>{{ params.pkg }}</h1>
|
|
119
|
+
</template>
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Passing Content
|
|
123
|
+
|
|
124
|
+
For heavy content (raw markdown/HTML from CMS), use `content` instead of params to avoid bloating the client bundle:
|
|
125
|
+
|
|
126
|
+
```js
|
|
127
|
+
// posts/[slug].paths.js
|
|
128
|
+
export default {
|
|
129
|
+
async paths() {
|
|
130
|
+
const posts = await fetch('https://cms.example.com/posts').then(r => r.json())
|
|
131
|
+
|
|
132
|
+
return posts.map(post => ({
|
|
133
|
+
params: { slug: post.slug },
|
|
134
|
+
content: post.content // Raw markdown or HTML
|
|
135
|
+
}))
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Render content in template:
|
|
141
|
+
|
|
142
|
+
```md
|
|
143
|
+
<!-- posts/[slug].md -->
|
|
144
|
+
---
|
|
145
|
+
title: {{ $params.title }}
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
<!-- @content -->
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
The `<!-- @content -->` placeholder is replaced with the content from the paths loader.
|
|
152
|
+
|
|
153
|
+
## Watch Option
|
|
154
|
+
|
|
155
|
+
Auto-rebuild when template or data files change:
|
|
156
|
+
|
|
157
|
+
```js
|
|
158
|
+
// posts/[slug].paths.js
|
|
159
|
+
export default {
|
|
160
|
+
watch: [
|
|
161
|
+
'./templates/**/*.njk',
|
|
162
|
+
'../data/**/*.json'
|
|
163
|
+
],
|
|
164
|
+
|
|
165
|
+
paths(watchedFiles) {
|
|
166
|
+
const dataFiles = watchedFiles.filter(f => f.endsWith('.json'))
|
|
167
|
+
|
|
168
|
+
return dataFiles.map(file => {
|
|
169
|
+
const data = JSON.parse(fs.readFileSync(file, 'utf-8'))
|
|
170
|
+
return {
|
|
171
|
+
params: { slug: data.slug },
|
|
172
|
+
content: renderTemplate(data)
|
|
173
|
+
}
|
|
174
|
+
})
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
## Complete Example: Blog
|
|
180
|
+
|
|
181
|
+
```js
|
|
182
|
+
// posts/[slug].paths.js
|
|
183
|
+
import fs from 'node:fs'
|
|
184
|
+
import matter from 'gray-matter'
|
|
185
|
+
|
|
186
|
+
export default {
|
|
187
|
+
watch: ['./posts/*.md'],
|
|
188
|
+
|
|
189
|
+
paths(files) {
|
|
190
|
+
return files
|
|
191
|
+
.filter(f => !f.includes('[slug]'))
|
|
192
|
+
.map(file => {
|
|
193
|
+
const content = fs.readFileSync(file, 'utf-8')
|
|
194
|
+
const { data, content: body } = matter(content)
|
|
195
|
+
const slug = file.match(/([^/]+)\.md$/)[1]
|
|
196
|
+
|
|
197
|
+
return {
|
|
198
|
+
params: {
|
|
199
|
+
slug,
|
|
200
|
+
title: data.title,
|
|
201
|
+
date: data.date
|
|
202
|
+
},
|
|
203
|
+
content: body
|
|
204
|
+
}
|
|
205
|
+
})
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
```md
|
|
211
|
+
<!-- posts/[slug].md -->
|
|
212
|
+
---
|
|
213
|
+
layout: doc
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
# {{ $params.title }}
|
|
217
|
+
|
|
218
|
+
<time>{{ $params.date }}</time>
|
|
219
|
+
|
|
220
|
+
<!-- @content -->
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
## Key Points
|
|
224
|
+
|
|
225
|
+
- Template file uses `[param]` syntax in filename
|
|
226
|
+
- Paths loader file must be named `[param].paths.js` or `.ts`
|
|
227
|
+
- `paths()` returns array of `{ params: {...}, content?: string }`
|
|
228
|
+
- Use `$params` in templates or `useData().params` in scripts
|
|
229
|
+
- Use `content` for heavy data to avoid client bundle bloat
|
|
230
|
+
- `watch` enables HMR for template/data file changes
|
|
231
|
+
|
|
232
|
+
<!--
|
|
233
|
+
Source references:
|
|
234
|
+
- https://vitepress.dev/guide/routing#dynamic-routes
|
|
235
|
+
-->
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vue-in-vitepress-markdown
|
|
3
|
+
description: Using Vue components, script setup, directives, and templating in markdown files
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vue in Markdown
|
|
7
|
+
|
|
8
|
+
VitePress markdown files are compiled as Vue Single-File Components, enabling full Vue functionality.
|
|
9
|
+
|
|
10
|
+
## Interpolation
|
|
11
|
+
|
|
12
|
+
Vue expressions work in markdown:
|
|
13
|
+
|
|
14
|
+
```md
|
|
15
|
+
{{ 1 + 1 }}
|
|
16
|
+
|
|
17
|
+
{{ new Date().toLocaleDateString() }}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Directives
|
|
21
|
+
|
|
22
|
+
HTML with Vue directives:
|
|
23
|
+
|
|
24
|
+
```md
|
|
25
|
+
<span v-for="i in 3">{{ i }}</span>
|
|
26
|
+
|
|
27
|
+
<div v-if="$frontmatter.showBanner">
|
|
28
|
+
Banner content
|
|
29
|
+
</div>
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Script and Style
|
|
33
|
+
|
|
34
|
+
Add `<script setup>` and `<style>` after frontmatter:
|
|
35
|
+
|
|
36
|
+
```md
|
|
37
|
+
---
|
|
38
|
+
title: My Page
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
<script setup>
|
|
42
|
+
import { ref } from 'vue'
|
|
43
|
+
import MyComponent from './MyComponent.vue'
|
|
44
|
+
|
|
45
|
+
const count = ref(0)
|
|
46
|
+
</script>
|
|
47
|
+
|
|
48
|
+
# {{ $frontmatter.title }}
|
|
49
|
+
|
|
50
|
+
Count: {{ count }}
|
|
51
|
+
|
|
52
|
+
<button @click="count++">Increment</button>
|
|
53
|
+
|
|
54
|
+
<MyComponent />
|
|
55
|
+
|
|
56
|
+
<style module>
|
|
57
|
+
.button {
|
|
58
|
+
color: red;
|
|
59
|
+
}
|
|
60
|
+
</style>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**Note:** Use `<style module>` instead of `<style scoped>` to avoid bloating page size.
|
|
64
|
+
|
|
65
|
+
## Importing Components
|
|
66
|
+
|
|
67
|
+
Local import (code-split per page):
|
|
68
|
+
|
|
69
|
+
```md
|
|
70
|
+
<script setup>
|
|
71
|
+
import CustomComponent from '../components/CustomComponent.vue'
|
|
72
|
+
</script>
|
|
73
|
+
|
|
74
|
+
<CustomComponent />
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Global Components
|
|
78
|
+
|
|
79
|
+
Register in theme for use everywhere:
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
// .vitepress/theme/index.ts
|
|
83
|
+
import DefaultTheme from 'vitepress/theme'
|
|
84
|
+
import MyGlobalComponent from './MyGlobalComponent.vue'
|
|
85
|
+
|
|
86
|
+
export default {
|
|
87
|
+
extends: DefaultTheme,
|
|
88
|
+
enhanceApp({ app }) {
|
|
89
|
+
app.component('MyGlobalComponent', MyGlobalComponent)
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Then use in any markdown:
|
|
95
|
+
|
|
96
|
+
```md
|
|
97
|
+
<MyGlobalComponent />
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Important:** Component names must contain a hyphen or be PascalCase to avoid being treated as inline HTML elements.
|
|
101
|
+
|
|
102
|
+
## Runtime API
|
|
103
|
+
|
|
104
|
+
Access VitePress data:
|
|
105
|
+
|
|
106
|
+
```md
|
|
107
|
+
<script setup>
|
|
108
|
+
import { useData, useRoute, useRouter } from 'vitepress'
|
|
109
|
+
|
|
110
|
+
const { page, frontmatter, theme, site } = useData()
|
|
111
|
+
const route = useRoute()
|
|
112
|
+
const router = useRouter()
|
|
113
|
+
</script>
|
|
114
|
+
|
|
115
|
+
Current page: {{ page.relativePath }}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Global Variables
|
|
119
|
+
|
|
120
|
+
Available without import:
|
|
121
|
+
|
|
122
|
+
```md
|
|
123
|
+
# {{ $frontmatter.title }}
|
|
124
|
+
|
|
125
|
+
Params: {{ $params.id }}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Components in Headers
|
|
129
|
+
|
|
130
|
+
```md
|
|
131
|
+
# My Title <Badge type="tip" text="v2.0" />
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Escaping Vue Syntax
|
|
135
|
+
|
|
136
|
+
Prevent Vue interpolation:
|
|
137
|
+
|
|
138
|
+
```md
|
|
139
|
+
<span v-pre>{{ will be displayed as-is }}</span>
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Or use container:
|
|
143
|
+
|
|
144
|
+
```md
|
|
145
|
+
::: v-pre
|
|
146
|
+
{{ this won't be processed }}
|
|
147
|
+
:::
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Vue in Code Blocks
|
|
151
|
+
|
|
152
|
+
Enable Vue processing in fenced code with `-vue` suffix:
|
|
153
|
+
|
|
154
|
+
````md
|
|
155
|
+
```js-vue
|
|
156
|
+
Hello {{ 1 + 1 }}
|
|
157
|
+
```
|
|
158
|
+
````
|
|
159
|
+
|
|
160
|
+
## CSS Pre-processors
|
|
161
|
+
|
|
162
|
+
Supported out of the box (install the preprocessor):
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
npm install -D sass # for .scss/.sass
|
|
166
|
+
npm install -D less # for .less
|
|
167
|
+
npm install -D stylus # for .styl/.stylus
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
```vue
|
|
171
|
+
<style lang="scss">
|
|
172
|
+
.title {
|
|
173
|
+
font-size: 20px;
|
|
174
|
+
}
|
|
175
|
+
</style>
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## Using Teleports
|
|
179
|
+
|
|
180
|
+
Teleport to body only with SSG:
|
|
181
|
+
|
|
182
|
+
```md
|
|
183
|
+
<ClientOnly>
|
|
184
|
+
<Teleport to="#modal">
|
|
185
|
+
<div>Modal content</div>
|
|
186
|
+
</Teleport>
|
|
187
|
+
</ClientOnly>
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## VS Code IntelliSense
|
|
191
|
+
|
|
192
|
+
Enable Vue language features for `.md` files:
|
|
193
|
+
|
|
194
|
+
```json
|
|
195
|
+
// tsconfig.json
|
|
196
|
+
{
|
|
197
|
+
"include": ["docs/**/*.ts", "docs/**/*.vue", "docs/**/*.md"],
|
|
198
|
+
"vueCompilerOptions": {
|
|
199
|
+
"vitePressExtensions": [".md"]
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
```json
|
|
205
|
+
// .vscode/settings.json
|
|
206
|
+
{
|
|
207
|
+
"vue.server.includeLanguages": ["vue", "markdown"]
|
|
208
|
+
}
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
## Key Points
|
|
212
|
+
|
|
213
|
+
- Markdown files are Vue SFCs - use `<script setup>` and `<style>`
|
|
214
|
+
- Access page data via `useData()` or `$frontmatter` global
|
|
215
|
+
- Import components locally or register globally in theme
|
|
216
|
+
- Use `<style module>` instead of `<style scoped>`
|
|
217
|
+
- Wrap non-SSR components in `<ClientOnly>`
|
|
218
|
+
- Component names must be PascalCase or contain hyphens
|
|
219
|
+
|
|
220
|
+
<!--
|
|
221
|
+
Source references:
|
|
222
|
+
- https://vitepress.dev/guide/using-vue
|
|
223
|
+
- https://vitepress.dev/reference/runtime-api
|
|
224
|
+
-->
|