docs: update docs (migrate from docusaurus to vitepress); test: add tests for setData(skipped temp)

Author: js2me

.eslintignore

@@ -17,4 +17,5 @@ jsconfig.json
 post-build.mjs
 coverage
 vitest.config.ts
-website
+website
+docs

.github/workflows/github-pages.yaml

@@ -25,14 +25,14 @@ jobs:
           cache: 'pnpm'
 
       - name: Install dependencies
-        run: cd website && pnpm install
-      - name: Build website
-        run: pnpm website:build
+        run: cd docs && pnpm install
+      - name: Build docs
+        run: pnpm build
 
       - name: Upload Build Artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: website/build
+          path: docs/.vitepress/dist
 
   deploy:
     name: Deploy to GitHub Pages

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
-coverage
+coverage
+docs/.vitepress/cache

Makefile

@@ -4,4 +4,10 @@ install:
 	pnpm i
 reinstall:
 	make clean
-	make install
+	make install
+doc:
+	cd docs && \
+	rm -rf node_modules && \
+	rm -rf .vitepress/cache && \
+	pnpm i && \
+	pnpm dev

README.md

@@ -394,8 +394,8 @@ export const queryClient = new QueryClient({
     queries: {
       throwOnError: true,
       queryKeyHashFn: hashKey,
-      refetchOnWindowFocus: 'always',
-      refetchOnReconnect: 'always',
+      refetchOnWindowFocus: true,
+      refetchOnReconnect: true,
       staleTime: 5 * 60 * 1000,
       retry: (failureCount, error) => {
         if ('status' in error && Number(error.status) >= 500) {

docs/.vitepress/config.mts

@@ -0,0 +1,77 @@
+import { defineConfig } from 'vitepress';
+
+import path from 'path';
+import fs from 'fs';
+
+const { version, name: packageName, author, license } = JSON.parse(
+  fs.readFileSync(
+    path.resolve(__dirname, '../../package.json'),
+    { encoding: 'utf-8' },
+  ),
+);
+
+export default defineConfig({
+  title: packageName.replace(/-/g, ' '),
+  description: `${packageName.replace(/-/g, ' ')} documentation`,
+  base: `/${packageName}/`,
+  lastUpdated: true,
+  head: [
+    ['link', { rel: 'icon', href: `/${packageName}/logo.png` }],
+  ],
+  themeConfig: {
+    logo: '/logo.png',
+    search: {
+      provider: 'local'
+    },
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Introduction', link: '/introduction/getting-started' },
+      {
+        text: `v${version}`,
+        items: [
+          {
+            items: [
+              {
+                text: `v${version}`,
+                link: `https://github.com/${author}/${packageName}/releases/tag/v${version}`,
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    sidebar: [
+      {
+        text: 'Introduction',
+        items: [
+          { text: 'Getting started', link: '/introduction/getting-started' },
+        ],
+      },
+      {
+        text: 'API',
+        items: [
+          { text: 'MobxQuery', link: '/api/MobxQuery' },
+          { text: 'MobxMutation', link: '/api/MobxMutation' },
+          { text: 'MobxInfiniteQuery', link: '/api/MobxInfiniteQuery' },
+          { text: 'MobxQueryClient', link: '/api/MobxQueryClient' },
+        ],
+      },
+      {
+        text: 'Other',
+        items: [
+          { text: 'Project examples', link: '/other/project-examples' },
+          { text: 'Swagger Codegen', link: '/other/swagger-codegen' },
+        ],
+      }
+    ],
+
+    footer: {
+      message: `Released under the ${license} License.`,
+      copyright: `Copyright © 2024-PRESENT ${author}`,
+    },
+
+    socialLinks: [
+      { icon: 'github', link: `https://github.com/${author}/${packageName}` },
+    ],
+  },
+});

docs/.vitepress/theme/index.ts

@@ -0,0 +1,18 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+import 'uno.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,191 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-indigo-1: #c87a45;
+  --vp-c-indigo-2: #ff8a4f;
+  --vp-c-indigo-3: #fb681f;
+  --vp-c-indigo-soft: #ff82512b;
+}
+
+ html.dark {
+  --vp-c-indigo-1: #ffae77;
+  --vp-c-indigo-2: #ff8a4f;
+  --vp-c-indigo-3: #fb681f;
+  --vp-c-indigo-soft: #ff662069;
+ }
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #ff1148 30%, #ff7a32);
+  --vp-home-hero-image-background-image: linear-gradient(-45deg, #ff542f 50%, #ffbbcf 50%);
+  --vp-home-hero-image-filter: blur(44px);
+} 
+
+html.dark {
+  --vp-home-hero-image-background-image: linear-gradient(-45deg, #ff510b 50%, #ff243d 50%);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+.i-logos\:mobx-icon {
+  background: url(/mobx.svg) no-repeat;
+  background-size: 100% 100%;
+  background-color: transparent;
+  width: 1.2em;
+  height: 1.2em;
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+
+@keyframes logoBgGradientAnimate {
+  0% {
+      background-position: 0% 0%;
+      transform: scale(1) translate(-50%, -50%);
+  }
+  50% {
+      background-position: 300% 300%;
+      transform: scale(1.4) translate(-35%, -35%);
+  }
+  100% {
+      background-position: 0% 0%;
+      transform: scale(1) translate(-50%, -50%);
+  }
+}
+
+.image-container > .image-bg {
+  background-size: 200% 200%;
+  animation: logoBgGradientAnimate 7s linear infinite;
+}
+
+@keyframes logoAnimate {
+  0% {
+      transform: scale(1) translate(-50%, -50%);
+  }
+  50% {
+      transform: scale(1.05) translate(-48%, -48%);
+  }
+  100% {
+      transform: scale(1) translate(-50%, -50%);
+  }
+}
+
+.image-container > .image-src {
+  animation: logoAnimate 10s linear infinite;
+}