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

|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Base URL
|
|
136
|
+
|
|
137
|
+
For sub-path deployment (e.g., GitHub Pages):
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
export default {
|
|
141
|
+
base: '/repo-name/'
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
All absolute paths are automatically prefixed with base. For dynamic paths in components, use `withBase`:
|
|
146
|
+
|
|
147
|
+
```vue
|
|
148
|
+
<script setup>
|
|
149
|
+
import { withBase } from 'vitepress'
|
|
150
|
+
</script>
|
|
151
|
+
|
|
152
|
+
<template>
|
|
153
|
+
<img :src="withBase('/logo.png')" />
|
|
154
|
+
</template>
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Key Points
|
|
158
|
+
|
|
159
|
+
- `index.md` files map to directory root (`/guide/` instead of `/guide/index`)
|
|
160
|
+
- Use paths without extensions in links for flexibility
|
|
161
|
+
- `srcDir` separates source from config
|
|
162
|
+
- `cleanUrls` removes `.html` but requires server support
|
|
163
|
+
- `rewrites` enables complex source structures with clean output URLs
|
|
164
|
+
|
|
165
|
+
<!--
|
|
166
|
+
Source references:
|
|
167
|
+
- https://vitepress.dev/guide/routing
|
|
168
|
+
- https://vitepress.dev/guide/asset-handling
|
|
169
|
+
-->
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vitepress-code-blocks
|
|
3
|
+
description: Syntax highlighting, line highlighting, colored diffs, focus, and line numbers
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Code Blocks
|
|
7
|
+
|
|
8
|
+
VitePress uses Shiki for syntax highlighting with powerful code block features.
|
|
9
|
+
|
|
10
|
+
## Syntax Highlighting
|
|
11
|
+
|
|
12
|
+
Specify language after opening backticks:
|
|
13
|
+
|
|
14
|
+
````md
|
|
15
|
+
```js
|
|
16
|
+
export default {
|
|
17
|
+
name: 'MyComponent'
|
|
18
|
+
}
|
|
19
|
+
```
|
|
20
|
+
````
|
|
21
|
+
|
|
22
|
+
Supports [all languages](https://shiki.style/languages) available in Shiki.
|
|
23
|
+
|
|
24
|
+
## Line Highlighting
|
|
25
|
+
|
|
26
|
+
Highlight specific lines:
|
|
27
|
+
|
|
28
|
+
````md
|
|
29
|
+
```js{4}
|
|
30
|
+
export default {
|
|
31
|
+
data() {
|
|
32
|
+
return {
|
|
33
|
+
msg: 'Highlighted!' // Line 4 highlighted
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
````
|
|
39
|
+
|
|
40
|
+
Multiple lines and ranges:
|
|
41
|
+
|
|
42
|
+
````md
|
|
43
|
+
```js{1,4,6-8}
|
|
44
|
+
// Line 1 highlighted
|
|
45
|
+
export default {
|
|
46
|
+
data() {
|
|
47
|
+
return { // Line 4
|
|
48
|
+
msg: 'Hi',
|
|
49
|
+
foo: 'bar', // Lines 6-8
|
|
50
|
+
baz: 'qux'
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
````
|
|
56
|
+
|
|
57
|
+
Inline highlighting with comment:
|
|
58
|
+
|
|
59
|
+
````md
|
|
60
|
+
```js
|
|
61
|
+
export default {
|
|
62
|
+
data() {
|
|
63
|
+
return {
|
|
64
|
+
msg: 'Highlighted!' // [!code highlight]
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
````
|
|
70
|
+
|
|
71
|
+
## Focus
|
|
72
|
+
|
|
73
|
+
Blur other code and focus specific lines:
|
|
74
|
+
|
|
75
|
+
````md
|
|
76
|
+
```js
|
|
77
|
+
export default {
|
|
78
|
+
data() {
|
|
79
|
+
return {
|
|
80
|
+
msg: 'Focused!' // [!code focus]
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
````
|
|
86
|
+
|
|
87
|
+
Focus multiple lines:
|
|
88
|
+
|
|
89
|
+
```js
|
|
90
|
+
// [!code focus:3]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Colored Diffs
|
|
94
|
+
|
|
95
|
+
Show additions and removals:
|
|
96
|
+
|
|
97
|
+
````md
|
|
98
|
+
```js
|
|
99
|
+
export default {
|
|
100
|
+
data() {
|
|
101
|
+
return {
|
|
102
|
+
msg: 'Removed' // [!code --]
|
|
103
|
+
msg: 'Added' // [!code ++]
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
````
|
|
109
|
+
|
|
110
|
+
## Errors and Warnings
|
|
111
|
+
|
|
112
|
+
Color lines as errors or warnings:
|
|
113
|
+
|
|
114
|
+
````md
|
|
115
|
+
```js
|
|
116
|
+
export default {
|
|
117
|
+
data() {
|
|
118
|
+
return {
|
|
119
|
+
msg: 'Error', // [!code error]
|
|
120
|
+
msg: 'Warning' // [!code warning]
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
````
|
|
126
|
+
|
|
127
|
+
## Line Numbers
|
|
128
|
+
|
|
129
|
+
Enable globally:
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
// .vitepress/config.ts
|
|
133
|
+
export default {
|
|
134
|
+
markdown: {
|
|
135
|
+
lineNumbers: true
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Per-block override:
|
|
141
|
+
|
|
142
|
+
````md
|
|
143
|
+
```ts:line-numbers
|
|
144
|
+
// Line numbers enabled
|
|
145
|
+
const a = 1
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
```ts:no-line-numbers
|
|
149
|
+
// Line numbers disabled
|
|
150
|
+
const b = 2
|
|
151
|
+
```
|
|
152
|
+
````
|
|
153
|
+
|
|
154
|
+
Start from specific number:
|
|
155
|
+
|
|
156
|
+
````md
|
|
157
|
+
```ts:line-numbers=5
|
|
158
|
+
// Starts at line 5
|
|
159
|
+
const a = 1 // This is line 5
|
|
160
|
+
const b = 2 // This is line 6
|
|
161
|
+
```
|
|
162
|
+
````
|
|
163
|
+
|
|
164
|
+
## Code Groups
|
|
165
|
+
|
|
166
|
+
Tabbed code blocks:
|
|
167
|
+
|
|
168
|
+
````md
|
|
169
|
+
::: code-group
|
|
170
|
+
|
|
171
|
+
```js [JavaScript]
|
|
172
|
+
export default { /* ... */ }
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
```ts [TypeScript]
|
|
176
|
+
export default defineConfig({ /* ... */ })
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
:::
|
|
180
|
+
````
|
|
181
|
+
|
|
182
|
+
## Import Code Snippets
|
|
183
|
+
|
|
184
|
+
From external files:
|
|
185
|
+
|
|
186
|
+
```md
|
|
187
|
+
<<< @/snippets/snippet.js
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
With highlighting:
|
|
191
|
+
|
|
192
|
+
```md
|
|
193
|
+
<<< @/snippets/snippet.js{2,4-6}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Specific region:
|
|
197
|
+
|
|
198
|
+
```md
|
|
199
|
+
<<< @/snippets/snippet.js#regionName{1,2}
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
With language and line numbers:
|
|
203
|
+
|
|
204
|
+
```md
|
|
205
|
+
<<< @/snippets/snippet.cs{1,2,4-6 c#:line-numbers}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
In code groups:
|
|
209
|
+
|
|
210
|
+
```md
|
|
211
|
+
::: code-group
|
|
212
|
+
|
|
213
|
+
<<< @/snippets/config.js [JavaScript]
|
|
214
|
+
<<< @/snippets/config.ts [TypeScript]
|
|
215
|
+
|
|
216
|
+
:::
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## File Labels
|
|
220
|
+
|
|
221
|
+
Add filename labels to code blocks:
|
|
222
|
+
|
|
223
|
+
````md
|
|
224
|
+
```js [vite.config.js]
|
|
225
|
+
export default defineConfig({})
|
|
226
|
+
```
|
|
227
|
+
````
|
|
228
|
+
|
|
229
|
+
## Key Points
|
|
230
|
+
|
|
231
|
+
- Use `// [!code highlight]` for inline highlighting
|
|
232
|
+
- Use `// [!code focus]` to focus with blur effect
|
|
233
|
+
- Use `// [!code ++]` and `// [!code --]` for diffs
|
|
234
|
+
- Use `// [!code error]` and `// [!code warning]` for status
|
|
235
|
+
- `:line-numbers` and `:no-line-numbers` control line numbers per block
|
|
236
|
+
- `@` in imports refers to source root
|
|
237
|
+
- Code groups create tabbed interfaces
|
|
238
|
+
|
|
239
|
+
<!--
|
|
240
|
+
Source references:
|
|
241
|
+
- https://vitepress.dev/guide/markdown#syntax-highlighting-in-code-blocks
|
|
242
|
+
- https://vitepress.dev/guide/markdown#line-highlighting-in-code-blocks
|
|
243
|
+
-->
|