docs: 文档构建配置

Author: cloudcome

docs/src/dts/env.d.ts

@@ -1,14 +1,25 @@
+/**
+ * env.d.ts
+ * @ref https://nodejs.org/api/process.html#processenv
+ */
+
 namespace NodeJS {
   interface ProcessEnv {
     /**
      * @see https://nodejs.org/api/process.html#processenv
      */
-    NODE_ENV: 'development' | 'production' | 'test';
+    readonly NODE_ENV: 'development' | 'production' | 'test';
+
+    /**
+     * package name
+     * defined in vite.config.mts
+     */
+    readonly PKG_NAME: string;
 
     /**
-     * vite 应用基础路径
-     * Github deploy action
+     * package version
+     * defined in vite.config.mts
      */
-    VITE_APP_BASENAME?: string;
+    readonly PKG_VERSION: string;
   }
 }

docs/src/dts/globals.d.ts

@@ -1,15 +1,9 @@
-declare global {
-  /**
-   * package name
-   * defined in vite.config.mts
-   */
-  export const PKG_NAME: string;
+/**
+ * globals.d.ts
+ */
 
-  /**
-   * package version
-   * defined in vite.config.mts
-   */
-  export const PKG_VERSION: string;
+declare global {
+  //
 }
 
 export {};

docs/src/dts/vite.d.ts

@@ -1,3 +1,8 @@
+/**
+ * vite.d.ts
+ * @ref https://vitejs.dev/guide/env-and-mode.html#intellisense-for-typescript
+ */
+
 /// <reference types="vite/client" />
 
 interface ImportMetaEnv {

docs/src/pages/(docs)/page.mdx

@@ -9,13 +9,13 @@ npm i -D unplugin-react-pages
 ```js
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react";
-import reactApp from "unplugin-react-pages";
+import { reactPages } from "unplugin-react-pages";
 
 export default defineConfig({
     plugins: [
         // plugins
         react(),
-        reactApp(),
+        reactPages.vite(),
     ],
 });
 ```

docs/vite.config.mts

@@ -8,57 +8,56 @@ import mdx from '@mdx-js/rollup';
 import react from '@vitejs/plugin-react';
 import rehypeHighlight from 'rehype-highlight';
 import uno from 'unocss/vite';
-import { defineConfig } from 'vite';
+import { defineConfig, loadEnv } from 'vite';
 import { createSvgIconsPlugin } from 'vite-plugin-svg-icons';
 import { ViteMinifyPlugin } from 'vite-plugin-minify';
-import { reactPages } from 'unplugin-react-pages';
+// import { reactPages } from 'unplugin-react-pages';
+import { reactPages } from '../src';
 import pkg from './package.json';
 
-export default defineConfig((config) => {
-  return {
-    base: process.env.VITE_APP_BASENAME || '/',
-    server: {
-      port: 15170,
-    },
-    define: {
-      PKG_NAME: JSON.stringify(config.mode === 'test' ? 'pkg-name-for-test' : pkg.name),
-      PKG_VERSION: JSON.stringify(config.mode === 'test' ? 'pkg-version-for-test' : pkg.version),
-    },
-    plugins: [
-      // plugins
-      react(),
-      mdx({
-        rehypePlugins: [
-          //
-          [
-            rehypeHighlight,
-            {
-              detect: true,
-            } as Parameters<typeof rehypeHighlight>[0],
-          ],
+export default defineConfig({
+  base: process.env.VITE_APP_BASENAME || '/',
+  server: {
+    port: 15170,
+  },
+  define: {
+    ['process.env.PKG_NAME']: JSON.stringify(pkg.name),
+    ['process.env.PKG_VERSION']: JSON.stringify(pkg.version),
+  },
+  plugins: [
+    // plugins
+    react(),
+    mdx({
+      rehypePlugins: [
+        //
+        [
+          rehypeHighlight,
+          {
+            detect: true,
+          } as Parameters<typeof rehypeHighlight>[0],
         ],
-      }),
-      uno(),
-      createSvgIconsPlugin({
-        iconDirs: [path.resolve('src/icons')],
-        symbolId: 'icon-[dir]/[name]',
-      }),
-      ViteMinifyPlugin({
-        minifyCSS: true,
-        minifyJS: true,
-        minifyURLs: true,
-        removeComments: true,
-        collapseWhitespace: true,
-        removeScriptTypeAttributes: true,
-        removeStyleLinkTypeAttributes: true,
-      }),
-      reactPages.vite({
-        debug: true,
-        logLevel: 'info',
-        fileNames: {
-          page: ['page.mdx', 'page.tsx'],
-        },
-      }),
-    ],
-  };
+      ],
+    }),
+    uno(),
+    createSvgIconsPlugin({
+      iconDirs: [path.resolve('src/icons')],
+      symbolId: 'icon-[dir]/[name]',
+    }),
+    ViteMinifyPlugin({
+      minifyCSS: true,
+      minifyJS: true,
+      minifyURLs: true,
+      removeComments: true,
+      collapseWhitespace: true,
+      removeScriptTypeAttributes: true,
+      removeStyleLinkTypeAttributes: true,
+    }),
+    reactPages.vite({
+      debug: true,
+      logLevel: 'info',
+      fileNames: {
+        page: ['page.mdx', 'page.tsx'],
+      },
+    }),
+  ],
 });