Skip to content

Commit 2a41ab7

Browse files
authored
Merge pull request #7523 from QwikDev/fix-api-docs
fix(docs): render API tables correctly
2 parents 868a944 + 18f3e23 commit 2a41ab7

File tree

24 files changed

+88
-39
lines changed

24 files changed

+88
-39
lines changed

packages/docs/src/routes/api/api.css

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,16 @@
6060
[data-theme="dark"] .docs.api table {
6161
box-shadow: 0 0 30px 0 rgba(80,80,80,0.1);
6262
}
63-
.docs.api thead tr {
64-
background: rgb(1 31 51);
65-
color: white;
63+
.docs.api article thead tr {
64+
background: #f6f6f6;
6665
text-align: left;
6766
}
67+
.docs.api article thead tr p {
68+
font-weight: bold;
69+
}
70+
[data-theme="dark"] .docs.api thead tr {
71+
background: #373737;
72+
}
6873
.docs.api thead th,
6974
.docs.api tbody tr td {
7075
padding: 12px 24px;
@@ -241,4 +246,4 @@
241246
}
242247
.docs.api .table-wrapper {
243248
overflow-x: auto;
244-
}
249+
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ AwsOpt
5555
</tbody></table>
5656
**Returns:**
5757

58-
{ fixPath: (pathT: string) =&gt; string; router: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: import("@builder.io/qwik-city/middleware/node").NodeRequestNextFunction) =&gt; Promise&lt;void&gt;; staticFile: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; notFound: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; handle: (req: any, res: any) =&gt; void; }
58+
\{ fixPath: (pathT: string) =&gt; string; router: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: import("@builder.io/qwik-city/middleware/node").NodeRequestNextFunction) =&gt; Promise&lt;void&gt;; staticFile: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; notFound: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; handle: (req: any, res: any) =&gt; void; }
5959

6060
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/aws-lambda/index.ts)
6161

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ opts
4545
</tbody></table>
4646
**Returns:**
4747

48-
(request: [PlatformCloudflarePages](#platformcloudflarepages)['request'], env: [PlatformCloudflarePages](#platformcloudflarepages)['env'] &amp; { ASSETS: { fetch: (req: Request) =&gt; Response; }; }, ctx: [PlatformCloudflarePages](#platformcloudflarepages)['ctx']) =&gt; Promise&lt;Response&gt;
48+
(request: [PlatformCloudflarePages](#platformcloudflarepages)['request'], env: [PlatformCloudflarePages](#platformcloudflarepages)['env'] &amp; \{ ASSETS: \{ fetch: (req: Request) =&gt; Response; }; }, ctx: [PlatformCloudflarePages](#platformcloudflarepages)['ctx']) =&gt; Promise&lt;Response&gt;
4949

5050
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/cloudflare-pages/index.ts)
5151

@@ -80,7 +80,7 @@ Description
8080

8181
</td><td>
8282

83-
{ waitUntil: (promise: Promise&lt;any&gt;) =&gt; void; }
83+
\{ waitUntil: (promise: Promise&lt;any&gt;) =&gt; void; }
8484

8585
</td><td>
8686

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ opts
5353
</tbody></table>
5454
**Returns:**
5555

56-
{ router: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: [NodeRequestNextFunction](#noderequestnextfunction)) =&gt; Promise&lt;void&gt;; notFound: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; staticFile: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; }
56+
\{ router: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: [NodeRequestNextFunction](#noderequestnextfunction)) =&gt; Promise&lt;void&gt;; notFound: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; staticFile: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; }
5757

5858
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)
5959

@@ -219,7 +219,7 @@ _(Optional)_
219219
220220
</td><td>
221221
222-
{ root?: string; cacheControl?: string; }
222+
\{ root?: string; cacheControl?: string; }
223223
224224
</td><td>
225225
File renamed without changes.

0 commit comments

Comments
 (0)