feat(docs): add package version

sxzz · sxzz · commit 9ee43b341b45 · 2024-07-24T08:10:06.000+08:00
diff --git a/docs/.vitepress/components/PackageVersion.vue b/docs/.vitepress/components/PackageVersion.vue
@@ -0,0 +1,16 @@
+<script setup lang="ts">
+defineProps<{
+  name: string
+}>()
+</script>
+
+<template>
+  <a
+    ml2
+    inline-block
+    :href="`https://www.npmjs.com/package/${name}`"
+    target="_blank"
+  >
+    <img alt="NPM Version" :src="`https://img.shields.io/npm/v/${name}`" />
+  </a>
+</template>
diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -1,6 +1,7 @@
 import { NolebaseGitChangelogPlugin } from '@nolebase/vitepress-plugin-git-changelog/client'
 import TwoslashFloatingVue from '@shikijs/vitepress-twoslash/client'
 import Theme from 'vitepress/theme'
+import PackageVersion from '../components/PackageVersion.vue'
 import StabilityLevel from '../components/StabilityLevel.vue'
 import WarnBadge from '../components/WarnBadge.vue'
 import Layout from './Layout.vue'
@@ -17,6 +18,7 @@ export default {
   enhanceApp({ app }: EnhanceAppContext) {
     app.component('WarnBadge', WarnBadge)
     app.component('StabilityLevel', StabilityLevel)
+    app.component('PackageVersion', PackageVersion)
     app.use(NolebaseGitChangelogPlugin, {
       mapAuthors: [
         {
diff --git a/docs/features/better-define.md b/docs/features/better-define.md
@@ -1,4 +1,4 @@
-# betterDefine
+# betterDefine <PackageVersion name="@vue-macros/better-define" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/features/boolean-prop.md b/docs/features/boolean-prop.md
@@ -1,4 +1,4 @@
-# booleanProp
+# booleanProp <PackageVersion name="@vue-macros/boolean-prop" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/features/export-expose.md b/docs/features/export-expose.md
@@ -1,4 +1,4 @@
-# exportExpose
+# exportExpose <PackageVersion name="@vue-macros/export-expose" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/features/export-props.md b/docs/features/export-props.md
@@ -1,4 +1,4 @@
-# exportProps
+# exportProps <PackageVersion name="@vue-macros/define-props" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/features/export-render.md b/docs/features/export-render.md
@@ -1,4 +1,4 @@
-# exportRender
+# exportRender <PackageVersion name="@vue-macros/export-render" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/features/hoist-static.md b/docs/features/hoist-static.md
@@ -1,4 +1,4 @@
-# hoistStatic
+# hoistStatic <PackageVersion name="@vue-macros/hoist-static" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/features/jsx-directive.md b/docs/features/jsx-directive.md
@@ -1,4 +1,4 @@
-# jsxDirective
+# jsxDirective <PackageVersion name="@vue-macros/jsx-directive" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/features/named-template.md b/docs/features/named-template.md
@@ -1,4 +1,4 @@
-# namedTemplate
+# namedTemplate <PackageVersion name="@vue-macros/named-template" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/features/reactivity-transform.md b/docs/features/reactivity-transform.md
@@ -1,4 +1,4 @@
-# Reactivity Transform
+# Reactivity Transform <PackageVersion name="@vue-macros/reactivity-transform" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/features/short-bind.md b/docs/features/short-bind.md
@@ -1,4 +1,4 @@
-# shortBind
+# shortBind <PackageVersion name="@vue-macros/short-bind" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/chain-call.md b/docs/macros/chain-call.md
@@ -1,4 +1,4 @@
-# chainCall
+# chainCall <PackageVersion name="@vue-macros/chain-call" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/macros/define-emit.md b/docs/macros/define-emit.md
@@ -1,4 +1,4 @@
-# defineEmit
+# defineEmit <PackageVersion name="@vue-macros/define-emit" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/macros/define-models.md b/docs/macros/define-models.md
@@ -1,4 +1,4 @@
-# defineModels
+# defineModels <PackageVersion name="@vue-macros/define-models" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/define-options.md b/docs/macros/define-options.md
@@ -1,4 +1,4 @@
-# defineOptions
+# defineOptions <PackageVersion name="unplugin-vue-define-options" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/define-prop.md b/docs/macros/define-prop.md
@@ -1,4 +1,4 @@
-# defineProp
+# defineProp <PackageVersion name="@vue-macros/define-prop" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/macros/define-props-refs.md b/docs/macros/define-props-refs.md
@@ -1,4 +1,4 @@
-# definePropsRefs
+# definePropsRefs <PackageVersion name="@vue-macros/define-props-refs" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/define-props.md b/docs/macros/define-props.md
@@ -1,4 +1,4 @@
-# defineProps
+# defineProps <PackageVersion name="@vue-macros/define-props" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/define-render.md b/docs/macros/define-render.md
@@ -1,4 +1,4 @@
-# defineRender
+# defineRender <PackageVersion name="@vue-macros/define-render" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/define-slots.md b/docs/macros/define-slots.md
@@ -1,4 +1,4 @@
-# defineSlots
+# defineSlots <PackageVersion name="@vue-macros/define-slots" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/setup-component.md b/docs/macros/setup-component.md
@@ -1,4 +1,4 @@
-# setupComponent
+# setupComponent <PackageVersion name="@vue-macros/setup-component" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/macros/setup-sfc.md b/docs/macros/setup-sfc.md
@@ -1,4 +1,4 @@
-# setupSFC
+# setupSFC <PackageVersion name="@vue-macros/setup-sfc" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/macros/short-emits.md b/docs/macros/short-emits.md
@@ -1,4 +1,4 @@
-# shortEmits
+# shortEmits <PackageVersion name="@vue-macros/short-emits" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/macros/short-vmodel.md b/docs/macros/short-vmodel.md
@@ -1,4 +1,4 @@
-# shortVmodel
+# shortVmodel <PackageVersion name="@vue-macros/short-vmodel" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/volar/template-ref.md b/docs/volar/template-ref.md
@@ -1,4 +1,4 @@
-# templateRef
+# templateRef <PackageVersion name="@vue-macros/volar" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/better-define.md b/docs/zh-CN/features/better-define.md
@@ -1,4 +1,4 @@
-# betterDefine
+# betterDefine <PackageVersion name="@vue-macros/better-define" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/features/boolean-prop.md b/docs/zh-CN/features/boolean-prop.md
@@ -1,4 +1,4 @@
-# booleanProp
+# booleanProp <PackageVersion name="@vue-macros/boolean-prop" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/export-expose.md b/docs/zh-CN/features/export-expose.md
@@ -1,4 +1,4 @@
-# exportExpose
+# exportExpose <PackageVersion name="@vue-macros/export-expose" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/export-props.md b/docs/zh-CN/features/export-props.md
@@ -1,4 +1,4 @@
-# exportProps
+# exportProps <PackageVersion name="@vue-macros/define-props" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/export-render.md b/docs/zh-CN/features/export-render.md
@@ -1,4 +1,4 @@
-# exportRender
+# exportRender <PackageVersion name="@vue-macros/export-render" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/hoist-static.md b/docs/zh-CN/features/hoist-static.md
@@ -1,4 +1,4 @@
-# hoistStatic
+# hoistStatic <PackageVersion name="@vue-macros/hoist-static" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/features/jsx-directive.md b/docs/zh-CN/features/jsx-directive.md
@@ -1,4 +1,4 @@
-# jsxDirective
+# jsxDirective <PackageVersion name="@vue-macros/jsx-directive" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/named-template.md b/docs/zh-CN/features/named-template.md
@@ -1,4 +1,4 @@
-# namedTemplate
+# namedTemplate <PackageVersion name="@vue-macros/named-template" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/features/reactivity-transform.md b/docs/zh-CN/features/reactivity-transform.md
@@ -1,4 +1,4 @@
-# Reactivity Transform
+# Reactivity Transform <PackageVersion name="@vue-macros/reactivity-transform" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/features/short-bind.md b/docs/zh-CN/features/short-bind.md
@@ -1,4 +1,4 @@
-# shortBind
+# shortBind <PackageVersion name="@vue-macros/short-bind" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/chain-call.md b/docs/zh-CN/macros/chain-call.md
@@ -1,4 +1,4 @@
-# chainCall
+# chainCall <PackageVersion name="@vue-macros/chain-call" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/macros/define-emit.md b/docs/zh-CN/macros/define-emit.md
@@ -1,4 +1,4 @@
-# defineEmit
+# defineEmit <PackageVersion name="@vue-macros/define-emit" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/macros/define-models.md b/docs/zh-CN/macros/define-models.md
@@ -1,4 +1,4 @@
-# defineModels
+# defineModels <PackageVersion name="@vue-macros/define-models" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/define-options.md b/docs/zh-CN/macros/define-options.md
@@ -1,4 +1,4 @@
-# defineOptions
+# defineOptions <PackageVersion name="unplugin-vue-define-options" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/define-prop.md b/docs/zh-CN/macros/define-prop.md
@@ -1,4 +1,4 @@
-# defineProp
+# defineProp <PackageVersion name="@vue-macros/define-prop" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/macros/define-props-refs.md b/docs/zh-CN/macros/define-props-refs.md
@@ -1,4 +1,4 @@
-# definePropsRefs
+# definePropsRefs <PackageVersion name="@vue-macros/define-props-refs" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/define-props.md b/docs/zh-CN/macros/define-props.md
@@ -1,4 +1,4 @@
-# defineProps
+# defineProps <PackageVersion name="@vue-macros/define-props" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/define-render.md b/docs/zh-CN/macros/define-render.md
@@ -1,4 +1,4 @@
-# defineRender
+# defineRender <PackageVersion name="@vue-macros/define-render" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/define-slots.md b/docs/zh-CN/macros/define-slots.md
@@ -1,4 +1,4 @@
-# defineSlots
+# defineSlots <PackageVersion name="@vue-macros/define-slots" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/setup-component.md b/docs/zh-CN/macros/setup-component.md
@@ -1,4 +1,4 @@
-# setupComponent
+# setupComponent <PackageVersion name="@vue-macros/setup-component" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/macros/setup-sfc.md b/docs/zh-CN/macros/setup-sfc.md
@@ -1,4 +1,4 @@
-# setupSFC
+# setupSFC <PackageVersion name="@vue-macros/setup-sfc" />
 
 <StabilityLevel level="experimental" />
 
diff --git a/docs/zh-CN/macros/short-emits.md b/docs/zh-CN/macros/short-emits.md
@@ -1,4 +1,4 @@
-# shortEmits
+# shortEmits <PackageVersion name="@vue-macros/short-emits" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/macros/short-vmodel.md b/docs/zh-CN/macros/short-vmodel.md
@@ -1,4 +1,4 @@
-# shortVmodel
+# shortVmodel <PackageVersion name="@vue-macros/short-vmodel" />
 
 <StabilityLevel level="stable" />
 
diff --git a/docs/zh-CN/volar/template-ref.md b/docs/zh-CN/volar/template-ref.md
@@ -1,4 +1,4 @@
-# templateRef
+# templateRef <PackageVersion name="@vue-macros/volar" />
 
 <StabilityLevel level="experimental" />
 
