chapter: configure docs search (#25)

chibivue-land · Apr 13, 2024 · 65da5dd · 65da5dd
1 parent 482a0a0
commit 65da5dd
Show file tree

Hide file tree

Showing 16 changed files with 2,542 additions and 889 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,9 +1,9 @@
 /* eslint-env node */
-require('@rushstack/eslint-patch/modern-module-resolution')
+require('@rushstack/eslint-patch/modern-module-resolution');
 
 module.exports = {
   root: true,
-  'extends': [
+  extends: [
     'plugin:vue/vue3-essential',
     'eslint:recommended',
     '@vue/eslint-config-typescript',
@@ -12,4 +12,4 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 'latest'
   }
-}
+};
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -5,4 +5,4 @@
   "singleQuote": true,
   "printWidth": 100,
   "trailingComma": "none"
-}
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,7 +1,3 @@
 {
-  "recommendations": [
-    "Vue.volar",
-    "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode"
-  ]
+  "recommendations": ["Vue.volar", "dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
 }
diff --git a/index.html b/index.html
@@ -1,9 +1,9 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
-    <meta charset="UTF-8">
-    <link rel="icon" href="/favicon.ico">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Vite App</title>
   </head>
   <body>

diff --git a/package.json b/package.json
@@ -45,4 +45,4 @@
     "vitepress": "^1.0.2",
     "vue-tsc": "^2.0.6"
   }
-}
+}
diff --git a/packages/.vitepress/config.ts b/packages/.vitepress/config.ts
@@ -10,15 +10,15 @@ const Guide = [
 export default defineConfig({
   title: 'VueYous',
   description: 'Craft Your Own VueUse Composables From Scratch',
-  head: [
-    [
-      'link',
-      { rel: 'icon', href: '/logo.png' }
-    ]
-  ],
+
+  head: [['link', { rel: 'icon', href: '/logo.png' }]],
+
+  // https://vitepress.dev/reference/default-theme-config
   themeConfig: {
+    search: { provider: 'local' },
     logo: '/logo.png',
     // https://vitepress.dev/reference/default-theme-config
+
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Guide', items: Guide }

diff --git a/packages/core/index.ts b/packages/core/index.ts
@@ -1,2 +1,2 @@
 export { useManualRefHistory } from './useManualRefHistory';
-export { useRefHistory } from './useRefHistory';
+export { useRefHistory } from './useRefHistory';
diff --git a/packages/core/useManualRefHistory/demo.vue b/packages/core/useManualRefHistory/demo.vue
@@ -17,24 +17,14 @@ const { canUndo, canRedo, history, commit, undo, redo } = useManualRefHistory(co
 
 <template>
   <div>Count: {{ count }}</div>
-  <button @click="inc()">
-    Increment
-  </button>
-  <button @click="dec()">
-    Decrement
-  </button>
+  <button @click="inc()">Increment</button>
+  <button @click="dec()">Decrement</button>
   <span class="ml-2">/</span>
-  <button @click="commit()">
-    Commit
-  </button>
-  <button :disabled="!canUndo" @click="undo()">
-    Undo
-  </button>
-  <button :disabled="!canRedo" @click="redo()">
-    Redo
-  </button>
-  <br>
-  <br>
+  <button @click="commit()">Commit</button>
+  <button :disabled="!canUndo" @click="undo()">Undo</button>
+  <button :disabled="!canRedo" @click="redo()">Redo</button>
+  <br />
+  <br />
   <note>History (limited to 10 records for demo)</note>
   <div class="code-block mt-4">
     <div v-for="i in history" :key="i.timestamp">

diff --git a/packages/core/useManualRefHistory/index.md b/packages/core/useManualRefHistory/index.md
@@ -3,4 +3,4 @@ category: State
 related: useManualRefHistory
 ---
 
-# useManualRefHistory
+# useManualRefHistory
diff --git a/packages/core/useRefHistory/index.ts b/packages/core/useRefHistory/index.ts
@@ -3,7 +3,7 @@ import { watchIgnorable } from '@vueyous/shared';
 
 import { useManualRefHistory, type UseManualRefHistoryReturn } from '../useManualRefHistory';
 
-export interface UseRefHistoryReturn<Raw> extends UseManualRefHistoryReturn<Raw> { }
+export interface UseRefHistoryReturn<Raw> extends UseManualRefHistoryReturn<Raw> {}
 
 export function useRefHistory<Raw>(source: Ref<Raw>) {
   const { ignoreUpdates } = watchIgnorable(source, commit);

diff --git a/packages/guide/index.md b/packages/guide/index.md
@@ -1,6 +1,5 @@
 # はじめに
 
-
 ## 本書の目的
 
 以下が本書の主な目的になります。
@@ -22,7 +21,6 @@
 - Vue.js を使ったことがある
 - Typescript を使ったことがある
 
-
 ## 本書の構成
 
-<!-- TODO: write about book structure  -->
+<!-- TODO: write about book structure  -->
diff --git a/packages/guide/setup.md b/packages/guide/setup.md
@@ -1,3 +1,3 @@
 # 環境構築
 
-<!-- TODO: write how to setup -->
+<!-- TODO: write how to setup -->
diff --git a/packages/guide/what-is-vueuse.md b/packages/guide/what-is-vueuse.md
@@ -1,3 +1,3 @@
 # VueUseとは
 
-<!-- TODO: write what is vueuse -->
+<!-- TODO: write what is vueuse -->
-Original file line number
+Diff line change
@@ Expand Up / @@ -45,4 +45,4 @@ @@
         "vitepress": "^1.0.2",
         "vue-tsc": "^2.0.6"
       }
-    }
+    }