chore: add global TS type in mdx

sheinsight · Aug 23, 2024 · 52900b6 · 52900b6
1 parent 085aac9
commit 52900b6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/docs/global.d.ts b/docs/global.d.ts
@@ -0,0 +1,9 @@
+type Category = string
+
+type Feature = 'Pausable' | 'IsSupported' | 'LowLevel' | 'DevOnly'
+
+declare const frontmatter: {
+  category: Category
+  features: Feature[]
+  deprecated?: boolean
+}
diff --git a/docs/rspress.config.ts b/docs/rspress.config.ts
@@ -64,7 +64,7 @@ export default defineConfig({
   builderPlugins,
   builderConfig: {
     html: {
-      tags: [{ tag: 'script', children: "window.RSPRESS_THEME = 'light';" }],
+      tags: process.env.IS_SODOC ? [{ tag: 'script', children: "window.RSPRESS_THEME = 'light';" }] : [],
     },
     output: {
       cleanDistPath: true,

diff --git a/docs/tsconfig.json b/docs/tsconfig.json
@@ -13,7 +13,7 @@
       "i18n": ["./i18n.json"]
     }
   },
-  "include": ["./src/**/*", "./docs/**/*", "../src/**/demo.tsx", "../src/**/*.mdx"],
+  "include": ["./global.d.ts", "./src/**/*", "./docs/**/*", "../src/**/demo.tsx", "../src/**/*.mdx"],
   "references": [{ "path": "./tsconfig.node.json" }],
   "mdx": {
     "checkMdx": true