Skip to content

Commit 670028d

Browse files
committed
Update docs
1 parent bb94135 commit 670028d

File tree

4 files changed

+29
-8
lines changed

4 files changed

+29
-8
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,17 @@ esbuild.build({
6868

6969
```tsx
7070
interface CSSPluginOptions {
71-
/** by default name is generated without hash so that it is easier and reliable for library users to override some CSS*/
72-
generateScopedName?: string | ((className: string, filename: string, css: string) => string);
71+
/**
72+
* By default name is generated without hash so that it is easier and reliable for library users to override some CSS.
73+
* Refer [loader-utils docs](https://github.com/webpack/loader-utils?tab=readme-ov-file#interpolatename) for more options
74+
* @defaultValue A function that generates name similar to [name]__[local] but without .module
75+
*/
76+
generateScopedName?: string | ((className: string, path: string, css: string) => string);
7377
/** set skipAutoPrefixer to true to disable autoprefixer */
7478
skipAutoPrefixer?: boolean;
75-
/** global CSS class prefix. @defaultValue "" */
79+
/** global CSS class prefix. @defaultValue undefined */
7680
globalPrefix?: string;
77-
/** If you want to keep .module.css files */
81+
/** If you want to keep .module.css files. @defaultValue undefined */
7882
keepModules?: boolean;
7983
}
8084
```

lib/esbuild-plugin-react18-css/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,17 @@ esbuild.build({
6868

6969
```tsx
7070
interface CSSPluginOptions {
71-
/** by default name is generated without hash so that it is easier and reliable for library users to override some CSS*/
72-
generateScopedName?: string | ((className: string, filename: string, css: string) => string);
71+
/**
72+
* By default name is generated without hash so that it is easier and reliable for library users to override some CSS.
73+
* Refer [loader-utils docs](https://github.com/webpack/loader-utils?tab=readme-ov-file#interpolatename) for more options
74+
* @defaultValue A function that generates name similar to [name]__[local] but without .module
75+
*/
76+
generateScopedName?: string | ((className: string, path: string, css: string) => string);
7377
/** set skipAutoPrefixer to true to disable autoprefixer */
7478
skipAutoPrefixer?: boolean;
75-
/** global CSS class prefix. @defaultValue "" */
79+
/** global CSS class prefix. @defaultValue undefined */
7680
globalPrefix?: string;
77-
/** If you want to keep .module.css files */
81+
/** If you want to keep .module.css files. @defaultValue undefined */
7882
keepModules?: boolean;
7983
}
8084
```

lib/esbuild-plugin-react18-css/package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@
3737
"tiny-glob": "^0.2.9",
3838
"tsup": "^8.0.2",
3939
"typedoc": "^0.25.13",
40+
"typedoc-plugin-inline-sources": "^1.0.2",
41+
"typedoc-plugin-mdn-links": "^3.1.23",
42+
"typedoc-plugin-missing-exports": "^2.2.0",
43+
"typedoc-plugin-rename-defaults": "^0.7.0",
44+
"typedoc-plugin-zod": "^1.1.2",
4045
"typescript": "^5.4.5",
4146
"vitest": "^1.5.2"
4247
},

lib/esbuild-plugin-react18-css/typedoc.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,12 @@ module.exports = {
66
tsconfig: "./tsconfig.doc.json",
77
out: "../../docs",
88
commentStyle: "all",
9+
searchInComments: true,
10+
plugin: [
11+
"typedoc-plugin-mdn-links",
12+
"typedoc-plugin-rename-defaults",
13+
"typedoc-plugin-missing-exports",
14+
"typedoc-plugin-zod",
15+
"typedoc-plugin-inline-sources",
16+
],
917
};

0 commit comments

Comments
 (0)