Merge pull request #934 from PhilippeR26/doc-search

Add search functionnality to the official website.

Author: tabaktoni

src/utils/calldata/enum/CairoCustomEnum.ts

@@ -8,15 +8,17 @@ export type CairoEnumRaw = {
  *  {Success: 234, Warning: undefined, Error: undefined}.
  *  Only one variant with a value, object, array.
  * @returns an instance representing a Cairo custom Enum.
- * @example ```typescript
+ * @example
+ * ```typescript
  * const myCairoEnum = new CairoCustomEnum( {Success: undefined, Warning: "0x7f32ea", Error: undefined})
  * ```
  */
 export class CairoCustomEnum {
   /**
    * direct readonly access to variants of the Cairo Custom Enum.
    * @returns a value of type any
-   * @example ```typescript
+   * @example
+   * ```typescript
    * const successValue = myCairoEnum.variant.Success;
    */
   readonly variant: CairoEnumRaw;

src/utils/calldata/enum/CairoOption.ts

@@ -8,7 +8,8 @@ export enum CairoOptionVariant {
  * @param variant CairoOptionVariant.Some or CairoOptionVariant.None
  * @param someContent value of type T.
  * @returns an instance representing a Cairo Option.
- * @example ```typescript
+ * @example
+ * ```typescript
  * const myOption = new CairoOption<BigNumberish>(CairoOptionVariant.Some, "0x54dda8");
  * ```
  */

src/utils/calldata/enum/CairoResult.ts

@@ -8,7 +8,8 @@ export enum CairoResultVariant {
  * @param variant CairoResultVariant.Ok or CairoResultVariant.Err
  * @param resultContent value of type T or U.
  * @returns an instance representing a Cairo Result.
- * @example ```typescript
+ * @example
+ * ```typescript
  * const myOption = new CairoResult<BigNumberish, CustomError>(CairoResultVariant.Ok, "0x54dda8");
  * ```
  */

www/docusaurus.config.js

@@ -38,7 +38,35 @@ const config = {
 
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
+    {
+      algolia: {
+        // The application ID provided by Algolia
+        appId: '86VVNRI64B',
+
+        // Public API key: it is safe to commit it
+        apiKey: '6f4db54e4ee0ae77619b41dbe862af7f',
+
+        indexName: 'starknetjs',
+
+        // Optional: see doc section below
+        contextualSearch: true,
+
+        // Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
+        //externalUrlRegex: 'external\\.com|domain\\.com',
+
+        // Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
+        //replaceSearchResultPathname: {
+        // from: '/docs/', // or as RegExp: /\/docs\//
+        // to: '/',
+
+        // Optional: Algolia search parameters
+        //searchParameters: {},
+
+        // Optional: path for search page that enabled by default (`false` to disable it)
+        //searchPagePath: 'search',
+
+        //... other Algolia param
+      },
       announcementBar: {
         content: `<a href="${migrationGuideLink}">Migrate from v4</a>`,
         backgroundColor: 'rgb(230 231 232)',
@@ -67,6 +95,7 @@ const config = {
             dropdownActiveClassDisabled: true,
             position: 'left',
           },
+
           {
             label: 'GitHub',
             href: 'https://github.com/starknet-io/starknet.js',
@@ -119,7 +148,7 @@ const config = {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
       },
-    }),
+    },
 
   plugins: [
     [
@@ -155,7 +184,6 @@ const config = {
           'Function',
           'Accessor',
           'Method',
-          'ObjectLiteral',
           'Parameter',
           'TypeParameter',
           'TypeLiteral',

www/package-lock.json

@@ -27,9 +27,9 @@
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^2.4.0",
     "@tsconfig/docusaurus": "^1.0.7",
-    "docusaurus-plugin-typedoc": "^0.19.2",
-    "typedoc": "^0.24.7",
-    "typedoc-plugin-markdown": "^3.15.3",
+    "docusaurus-plugin-typedoc": "^0.21.0",
+    "typedoc": "^0.25.4",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.0.4"
   },
   "browserslist": {