Merge pull request #8391 from fkatsuhiro/fix/conflicting-links-and-entries-build-logic

fix(docs): Conflicting links and entries in API reference page

Author: wmertens

packages/docs/src/routes/api/index.tsx

@@ -1,6 +1,5 @@
 import { $, component$, useOn, useSignal, useStore, useTask$, isBrowser } from '@builder.io/qwik';
 import { Link } from '@builder.io/qwik-city';
-
 import { toSnakeCase } from '../../utils/utils';
 
 // TODO: load the content of these files using fs instead of importing them
@@ -140,32 +139,45 @@ export const ApiMemberWrapper = component$(({ id, data, filters }: any) => {
 });
 
 
-export const ApiMemberList = component$(({ id, data, filters }: any) => (
-  <ul class="grid sm:grid-cols-2 lg:grid-cols-3 pb-5">
-    {data.members.map((member: any) => {
-      const kind = toSnakeCase(member.kind);
-
-      if (!member.name) {
-        return;
-      }
-
-      const name = member.name.toLowerCase()
-        .replace(/[^a-zA-Z0-9]/g, '')
-        .replace(/ /g, '-');
-
-
-      return (
-        <li
-          key={`${id}-member-${member.id}-${kind}`}
-          data-kind={kind}
-          data-kind-label={kind.substring(0, 1).toUpperCase()}
-          class={`api-item list-none text-xs ${
-            (kind in filters && !filters[kind] && 'hidden') || ''
-          }`}
-        >
-          <Link href={`${data.id}#${name}`}>{member.name}</Link>
-        </li>
-      );
-    })}
-  </ul>
-));
+export const ApiMemberList = component$(({ id, data, filters }: any) => {
+  const nameCounts = data.members.reduce((acc: Record<string, number>, m: any) => {
+    if (m.name) {
+      const normalizedName = m.name.toLowerCase();
+      acc[normalizedName] = (acc[normalizedName] || 0) + 1;
+    }
+    return acc;
+  }, {});
+  return (
+    <ul class="grid sm:grid-cols-2 lg:grid-cols-3 pb-5">
+      {data.members.map((member: any) => {
+        const kind = toSnakeCase(member.kind);
+
+        if (!member.name) {
+          return;
+        }
+      
+        const name = member.name.toLowerCase()
+            .replace(/[$]/g, '_')
+            .replace(/[^a-zA-Z0-9_]/g, '')
+            .replace(/ /g, '-');
+
+        const anchorId = nameCounts[member.name.toLowerCase()] > 1 
+            ? `${name}-${kind}`
+            : name;
+
+        return (
+          <li
+            key={`${id}-member-${member.id}-${kind}`}
+            data-kind={kind}
+            data-kind-label={kind.substring(0, 1).toUpperCase()}
+            class={`api-item list-none text-xs ${
+              (kind in filters && !filters[kind] && 'hidden') || ''
+            }`}
+          >
+            <Link href={`${data.id}#${anchorId}`}>{member.name}</Link>
+          </li>
+        );
+      })}
+    </ul>
+  );
+});

packages/docs/src/routes/api/qwik-city-middleware-aws-lambda/index.mdx

@@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/aws-lambda API Reference
 
 # [API](/api) › @builder.io/qwik-city/middleware/aws-lambda
 
-## createQwikCity
+<h2 id="createqwikcity">createQwikCity</h2>
 
 ```typescript
 export declare function createQwikCity(opts: AwsOpt): {
@@ -60,7 +60,7 @@ AwsOpt
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/aws-lambda/index.ts)
 
-## PlatformAwsLambda
+<h2 id="platformawslambda">PlatformAwsLambda</h2>
 
 ```typescript
 export interface PlatformAwsLambda extends Object
@@ -70,7 +70,7 @@ export interface PlatformAwsLambda extends Object
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/aws-lambda/index.ts)
 
-## QwikCityAwsLambdaOptions
+<h2 id="qwikcityawslambdaoptions">QwikCityAwsLambdaOptions</h2>
 
 ```typescript
 export interface QwikCityAwsLambdaOptions extends ServerRenderOptions

packages/docs/src/routes/api/qwik-city-middleware-azure-swa/index.mdx

@@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/azure-swa API Reference
 
 # [API](/api) › @builder.io/qwik-city/middleware/azure-swa
 
-## createQwikCity
+<h2 id="createqwikcity">createQwikCity</h2>
 
 ```typescript
 export declare function createQwikCity(
@@ -44,7 +44,7 @@ AzureFunction
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/azure-swa/index.ts)
 
-## PlatformAzure
+<h2 id="platformazure">PlatformAzure</h2>
 
 ```typescript
 export interface PlatformAzure extends Partial<Context>
@@ -54,7 +54,7 @@ export interface PlatformAzure extends Partial<Context>
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/azure-swa/index.ts)
 
-## QwikCityAzureOptions
+<h2 id="qwikcityazureoptions">QwikCityAzureOptions</h2>
 
 ```typescript
 export interface QwikCityAzureOptions extends ServerRenderOptions

packages/docs/src/routes/api/qwik-city-middleware-cloudflare-pages/index.mdx

@@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/cloudflare-pages API Reference
 
 # [API](/api) › @builder.io/qwik-city/middleware/cloudflare-pages
 
-## createQwikCity
+<h2 id="createqwikcity">createQwikCity</h2>
 
 ```typescript
 export declare function createQwikCity(opts: QwikCityCloudflarePagesOptions): (
@@ -50,7 +50,7 @@ opts
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/cloudflare-pages/index.ts)
 
-## PlatformCloudflarePages
+<h2 id="platformcloudflarepages">PlatformCloudflarePages</h2>
 
 ```typescript
 export interface PlatformCloudflarePages
@@ -118,7 +118,7 @@ Request
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/cloudflare-pages/index.ts)
 
-## QwikCityCloudflarePagesOptions
+<h2 id="qwikcitycloudflarepagesoptions">QwikCityCloudflarePagesOptions</h2>
 
 ```typescript
 export interface QwikCityCloudflarePagesOptions extends ServerRenderOptions

packages/docs/src/routes/api/qwik-city-middleware-firebase/index.mdx

@@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/firebase API Reference
 
 # [API](/api) › @builder.io/qwik-city/middleware/firebase
 
-## createQwikCity
+<h2 id="createqwikcity">createQwikCity</h2>
 
 ```typescript
 export declare function createQwikCity(
@@ -44,7 +44,7 @@ opts
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/firebase/index.ts)
 
-## PlatformFirebase
+<h2 id="platformfirebase">PlatformFirebase</h2>
 
 ```typescript
 export interface PlatformFirebase extends Object
@@ -54,7 +54,7 @@ export interface PlatformFirebase extends Object
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/firebase/index.ts)
 
-## QwikCityFirebaseOptions
+<h2 id="qwikcityfirebaseoptions">QwikCityFirebaseOptions</h2>
 
 ```typescript
 export interface QwikCityFirebaseOptions extends ServerRenderOptions

packages/docs/src/routes/api/qwik-city-middleware-netlify-edge/index.mdx

@@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/netlify-edge API Reference
 
 # [API](/api) › @builder.io/qwik-city/middleware/netlify-edge
 
-## createQwikCity
+<h2 id="createqwikcity">createQwikCity</h2>
 
 ```typescript
 export declare function createQwikCity(
@@ -44,7 +44,7 @@ opts
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/netlify-edge/index.ts)
 
-## PlatformNetlify
+<h2 id="platformnetlify">PlatformNetlify</h2>
 
 ```typescript
 export interface PlatformNetlify extends Partial<Omit<Context, 'next' | 'cookies'>>
@@ -54,7 +54,7 @@ export interface PlatformNetlify extends Partial<Omit<Context, 'next' | 'cookies
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/netlify-edge/index.ts)
 
-## QwikCityNetlifyOptions
+<h2 id="qwikcitynetlifyoptions">QwikCityNetlifyOptions</h2>
 
 ```typescript
 export interface QwikCityNetlifyOptions extends ServerRenderOptions

packages/docs/src/routes/api/qwik-city-middleware-node/index.mdx

@@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/node API Reference
 
 # [API](/api) › @builder.io/qwik-city/middleware/node
 
-## createQwikCity
+<h2 id="createqwikcity">createQwikCity</h2>
 
 ```typescript
 export declare function createQwikCity(opts: QwikCityNodeRequestOptions): {
@@ -58,15 +58,15 @@ opts
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)
 
-## NodeRequestNextFunction
+<h2 id="noderequestnextfunction">NodeRequestNextFunction</h2>
 
 ```typescript
 export interface NodeRequestNextFunction
 ```
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)
 
-## PlatformNode
+<h2 id="platformnode">PlatformNode</h2>
 
 ```typescript
 export interface PlatformNode
@@ -138,7 +138,7 @@ _(Optional)_
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)
 
-## QwikCityNodeRequestOptions
+<h2 id="qwikcitynoderequestoptions">QwikCityNodeRequestOptions</h2>
 
 ```typescript
 export interface QwikCityNodeRequestOptions extends ServerRenderOptions