Update docs

react18-tools · Apr 28, 2024 · 670028d · 670028d
1 parent bb94135
commit 670028d
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -68,13 +68,17 @@ esbuild.build({
 
 ```tsx
 interface CSSPluginOptions {
-  /** by default name is generated without hash so that it is easier and reliable for library users to override some CSS*/
-  generateScopedName?: string | ((className: string, filename: string, css: string) => string);
+  /**
+   * By default name is generated without hash so that it is easier and reliable for library users to override some CSS.
+   * Refer [loader-utils docs](https://github.com/webpack/loader-utils?tab=readme-ov-file#interpolatename) for more options
+   * @defaultValue A function that generates name similar to [name]__[local] but without .module
+   */
+  generateScopedName?: string | ((className: string, path: string, css: string) => string);
   /** set skipAutoPrefixer to true to disable autoprefixer */
   skipAutoPrefixer?: boolean;
-  /** global CSS class prefix. @defaultValue "" */
+  /** global CSS class prefix. @defaultValue undefined */
   globalPrefix?: string;
-  /** If you want to keep .module.css files */
+  /** If you want to keep .module.css files. @defaultValue undefined */
   keepModules?: boolean;
 }
 ```

diff --git a/lib/esbuild-plugin-react18-css/README.md b/lib/esbuild-plugin-react18-css/README.md
@@ -68,13 +68,17 @@ esbuild.build({
 
 ```tsx
 interface CSSPluginOptions {
-  /** by default name is generated without hash so that it is easier and reliable for library users to override some CSS*/
-  generateScopedName?: string | ((className: string, filename: string, css: string) => string);
+  /**
+   * By default name is generated without hash so that it is easier and reliable for library users to override some CSS.
+   * Refer [loader-utils docs](https://github.com/webpack/loader-utils?tab=readme-ov-file#interpolatename) for more options
+   * @defaultValue A function that generates name similar to [name]__[local] but without .module
+   */
+  generateScopedName?: string | ((className: string, path: string, css: string) => string);
   /** set skipAutoPrefixer to true to disable autoprefixer */
   skipAutoPrefixer?: boolean;
-  /** global CSS class prefix. @defaultValue "" */
+  /** global CSS class prefix. @defaultValue undefined */
   globalPrefix?: string;
-  /** If you want to keep .module.css files */
+  /** If you want to keep .module.css files. @defaultValue undefined */
   keepModules?: boolean;
 }
 ```

diff --git a/lib/esbuild-plugin-react18-css/package.json b/lib/esbuild-plugin-react18-css/package.json
@@ -37,6 +37,11 @@
     "tiny-glob": "^0.2.9",
     "tsup": "^8.0.2",
     "typedoc": "^0.25.13",
+    "typedoc-plugin-inline-sources": "^1.0.2",
+    "typedoc-plugin-mdn-links": "^3.1.23",
+    "typedoc-plugin-missing-exports": "^2.2.0",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
+    "typedoc-plugin-zod": "^1.1.2",
     "typescript": "^5.4.5",
     "vitest": "^1.5.2"
   },

diff --git a/lib/esbuild-plugin-react18-css/typedoc.config.js b/lib/esbuild-plugin-react18-css/typedoc.config.js
@@ -6,4 +6,12 @@ module.exports = {
   tsconfig: "./tsconfig.doc.json",
   out: "../../docs",
   commentStyle: "all",
+  searchInComments: true,
+  plugin: [
+    "typedoc-plugin-mdn-links",
+    "typedoc-plugin-rename-defaults",
+    "typedoc-plugin-missing-exports",
+    "typedoc-plugin-zod",
+    "typedoc-plugin-inline-sources",
+  ],
 };