diff --git a/packages/plugin-stylus/src/index.ts b/packages/plugin-stylus/src/index.ts index 5d293a72f8..c4aa3ddf12 100644 --- a/packages/plugin-stylus/src/index.ts +++ b/packages/plugin-stylus/src/index.ts @@ -9,7 +9,17 @@ export const PLUGIN_STYLUS_NAME = 'rsbuild:stylus'; type StylusOptions = { use?: string[]; - define?: [string, any, boolean?]; + /** + * Define Stylus variables or functions. + * + * @default {} + * @example + * define: [ + * ["$development", process.env.NODE_ENV === "development"], + * ["rawVar", 42, true], + * ] + */ + define?: [string, any, boolean?][]; include?: string[]; /** * Import the specified Stylus files/paths, can not be relative path. diff --git a/website/docs/en/plugins/list/plugin-stylus.mdx b/website/docs/en/plugins/list/plugin-stylus.mdx index 555cab722b..8ab8a3aac7 100644 --- a/website/docs/en/plugins/list/plugin-stylus.mdx +++ b/website/docs/en/plugins/list/plugin-stylus.mdx @@ -67,7 +67,7 @@ To customize the compilation behavior of Stylus, use the following options. ```ts type StylusOptions = { use?: string[]; - define?: [string, any, boolean?]; + define?: [string, any, boolean?][]; include?: string[]; import?: string[]; resolveURL?: boolean; diff --git a/website/docs/zh/plugins/list/plugin-stylus.mdx b/website/docs/zh/plugins/list/plugin-stylus.mdx index 9e07411f59..7f1834625b 100644 --- a/website/docs/zh/plugins/list/plugin-stylus.mdx +++ b/website/docs/zh/plugins/list/plugin-stylus.mdx @@ -67,7 +67,7 @@ console.log(style.title); ```ts type StylusOptions = { use?: string[]; - define?: [string, any, boolean?]; + define?: [string, any, boolean?][]; include?: string[]; import?: string[]; resolveURL?: boolean;