docs: add helper docs (#56)

vuepress · Feb 3, 2024 · df2751c · df2751c
1 parent 1900257
commit df2751c
Show file tree

Hide file tree

Showing 18 changed files with 1,470 additions and 9 deletions.
diff --git a/docs/.vuepress/configs/navbar/en.ts b/docs/.vuepress/configs/navbar/en.ts
@@ -8,6 +8,10 @@ export const navbarEn: NavbarConfig = [
         text: 'Default Theme',
         link: '/themes/default/',
       },
+      {
+        text: 'Hope Theme',
+        link: 'https://theme-hope.vuejs.press',
+      },
     ],
   },
   {
@@ -62,4 +66,13 @@ export const navbarEn: NavbarConfig = [
       },
     ],
   },
+  {
+    text: 'Tools',
+    children: [
+      {
+        text: 'helper',
+        link: '/tools/helper/',
+      },
+    ],
+  },
 ]
diff --git a/docs/.vuepress/configs/navbar/zh.ts b/docs/.vuepress/configs/navbar/zh.ts
@@ -8,6 +8,10 @@ export const navbarZh: NavbarConfig = [
         text: '默认主题',
         link: '/zh/themes/default/',
       },
+      {
+        text: 'Hope 主题',
+        link: 'https://theme-hope.vuejs.press/zh/',
+      },
     ],
   },
   {
@@ -66,4 +70,13 @@ export const navbarZh: NavbarConfig = [
       },
     ],
   },
+  {
+    text: '工具',
+    children: [
+      {
+        text: 'helper',
+        link: '/zh/tools/helper/',
+      },
+    ],
+  },
 ]
diff --git a/docs/.vuepress/configs/sidebar/en.ts b/docs/.vuepress/configs/sidebar/en.ts
@@ -80,8 +80,8 @@ export const sidebarEn: SidebarConfig = {
   '/themes/': [
     {
       text: 'Default Theme',
+      link: '/themes/default/',
       children: [
-        '/themes/default/',
         '/themes/default/config',
         '/themes/default/plugin',
         '/themes/default/locale',
@@ -93,4 +93,16 @@ export const sidebarEn: SidebarConfig = {
       ],
     },
   ],
+  '/tools/': [
+    {
+      text: '@vuepress/helper',
+      link: '/tools/helper/',
+      children: [
+        '/tools/helper/node/bundler',
+        '/tools/helper/node/page',
+        '/tools/helper/client',
+        '/tools/helper/shared',
+      ],
+    },
+  ],
 }
diff --git a/docs/.vuepress/configs/sidebar/zh.ts b/docs/.vuepress/configs/sidebar/zh.ts
@@ -85,8 +85,8 @@ export const sidebarZh: SidebarConfig = {
   '/zh/themes/': [
     {
       text: '默认主题',
+      link: '/zh/themes/default/',
       children: [
-        '/zh/themes/default/',
         '/zh/themes/default/config',
         '/zh/themes/default/plugin',
         '/zh/themes/default/locale',
@@ -98,4 +98,16 @@ export const sidebarZh: SidebarConfig = {
       ],
     },
   ],
+  '/zh/tools/': [
+    {
+      text: '@vuepress/helper',
+      link: '/zh/tools/helper/',
+      children: [
+        '/zh/tools/helper/node/bundler',
+        '/zh/tools/helper/node/page',
+        '/zh/tools/helper/client',
+        '/zh/tools/helper/shared',
+      ],
+    },
+  ],
 }
diff --git a/docs/themes/default/locale.md b/docs/themes/default/locale.md
@@ -71,15 +71,15 @@ export default {
 }
 ```
 
-### navbarLabel
+## navbarLabel
 
 - Type: `null | string`
 
 - Details:
 
   `aria-label` value for main navigation in navbar.
 
-### pageNavbarLabel
+## pageNavbarLabel
 
 - Type: `null | string`
 

diff --git a/docs/tools/helper/README.md b/docs/tools/helper/README.md
@@ -0,0 +1,13 @@
+# @vuepress/helper
+
+<NpmBadge package="@vuepress/helper" />
+
+This package is a helper utility for VuePress developers.
+
+- `@vuepress/helper`: Node.js side helper utilities.
+
+  - [Bundler Related](node/bundler.md)
+  - [Page Related](node/page.md)
+
+- [`@vuepress/helper/client`](client.md): Client side helper utilities.
+- [`@vuepress/helper/shared`](shared.md): Utilities that are both available at Node.js side or Client.
diff --git a/docs/tools/helper/client.md b/docs/tools/helper/client.md
@@ -0,0 +1,59 @@
+# Client Related
+
+## Composables APIs
+
+### hasGlobalComponent
+
+Check whether a component is registered globally.
+
+::: tip
+
+1. Local import of the component does not affect the result.
+1. When calling outside `setup` scope, you need to pass the `app` instance as the second parameter.
+
+:::
+
+```ts
+export const hasGlobalComponent: (name: string, app?: App) => boolean
+```
+
+::: details Example
+
+```ts
+// if you globally register `<my-component>`
+hasGlobalComponent('MyComponent') // true
+hasGlobalComponent('my-component') // true
+
+hasGlobalComponent('MyComponent2') // false
+```
+
+:::
+
+### useLocaleConfig
+
+Get current locale config from locales settings.
+
+```ts
+export const useLocaleConfig: <T extends LocaleData>(
+  localesConfig: RequiredLocaleConfig<T>,
+) => ComputedRef<T>
+```
+
+::: details Example
+
+```ts
+const localesCOnfig = {
+  '/': 'Title',
+  '/zh/': '标题',
+}
+
+const locale = useLocaleConfig(localesConfig)
+
+// under `/page`
+locale.value // 'Title'
+
+// under `/zh/page`
+locale.value // '标题'
+```
+
+:::