Skip to content

Commit c0d77c0

Browse files
wellwelwelwellwelwel
authored
feat(docs): release documentation website (#2339)
* docs: resolve GitHub MDX parser conflict * docs: fix i18n home breadcrumb
1 parent 323ab12 commit c0d77c0

File tree

22 files changed

+109
-105
lines changed

22 files changed

+109
-105
lines changed

‎website/docs/contributing/website.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';
1111

1212
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
1313

14-
---
14+
<hr />
1515

1616
## Environment
1717

1818
You will need these tools installed on your system:
1919

2020
- [Node.js (18.x or higher)](https://nodejs.org/)
2121

22-
---
22+
<hr />
2323

2424
## Development
2525

@@ -58,7 +58,7 @@ Note that the website has its own _package.json_.
5858
Please, do not install dependencies for the website in **node-mysql2** root.
5959
:::
6060

61-
---
61+
<hr />
6262

6363
## Extras Components
6464

@@ -100,7 +100,7 @@ You can also utilize React components in the `changes` option.
100100
/>
101101
</FAQ>
102102

103-
---
103+
<hr />
104104

105105
### Stability
106106

@@ -126,7 +126,7 @@ Available levels: `0`, `1`, `1.1`, `1.2`, `2` and `3`.
126126
<Stability level={2} message='Some message.' />
127127
</FAQ>
128128

129-
---
129+
<hr />
130130

131131
### FAQ
132132

@@ -157,7 +157,7 @@ import { FAQ } from '@site/src/components/FAQ';
157157
</FAQ>
158158
</FAQ>
159159

160-
---
160+
<hr />
161161

162162
### ExternalCodeEmbed
163163

@@ -193,7 +193,7 @@ import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';
193193
/>
194194
</FAQ>
195195

196-
---
196+
<hr />
197197

198198
## Running Tests
199199

‎website/docs/documentation/00-index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ Not only **MySQL2** offers better performance over [Node MySQL][node-mysql], we
2929
- MySQL Compression
3030
- Binary Log Protocol Client
3131

32-
---
32+
<hr />
3333

3434
## Examples
3535

3636
Please check these [examples](/docs/examples) for **MySQL2**.
3737

38-
---
38+
<hr />
3939

4040
## Known incompatibilities with [Node MySQL][node-mysql]
4141

@@ -54,7 +54,7 @@ Please check these [examples](/docs/examples) for **MySQL2**.
5454
This option could lose precision on the number as Javascript Number is a Float!
5555
:::
5656

57-
---
57+
<hr />
5858

5959
## Other Resources
6060

@@ -64,7 +64,7 @@ This option could lose precision on the number as Javascript Number is a Float!
6464
- [node-libmysqlclient](https://github.com/Sannis/node-mysql-libmysqlclient) - Bindings to libmysqlclient
6565
- [go-mysql](https://github.com/siddontang/go-mysql) - MySQL Go client (prepared statements, binlog protocol, server)
6666

67-
---
67+
<hr />
6868

6969
## Benchmarks
7070

‎website/docs/documentation/mysql-server.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
- **connect**
1111
- new incoming connection.
1212

13-
---
13+
<hr />
1414

1515
## Connection
1616

‎website/docs/documentation/typescript-examples.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ npm install --save-dev @types/node
1616
Requires **TypeScript** `>=4.5.2`.
1717
:::
1818

19-
---
19+
<hr />
2020

2121
## Usage
2222

@@ -90,7 +90,7 @@ The `rows` output will be these possible types:
9090

9191
In this example, you need to manually check the output types
9292

93-
---
93+
<hr />
9494

9595
## Type Specification
9696

@@ -156,7 +156,7 @@ conn.query<RowDataPacket[]>('SHOW TABLES FROM `test`;', (_err, rows) => {
156156
});
157157
```
158158

159-
---
159+
<hr />
160160

161161
### RowDataPacket[][]
162162

@@ -186,7 +186,7 @@ conn.query<RowDataPacket[][]>(sql, (_err, rows) => {
186186
});
187187
```
188188

189-
---
189+
<hr />
190190

191191
### ResultSetHeader
192192

@@ -244,7 +244,7 @@ conn.query<ResultSetHeader>(sql, (_err, result) => {
244244
});
245245
```
246246

247-
---
247+
<hr />
248248

249249
### ResultSetHeader[]
250250

@@ -306,7 +306,7 @@ conn.query<ResultSetHeader[]>(sql, (_err, results) => {
306306
});
307307
```
308308

309-
---
309+
<hr />
310310

311311
### ProcedureCallPacket
312312

@@ -379,7 +379,7 @@ By using `SELECT` and `SHOW` queries in a **Procedure Call**, it groups the resu
379379

380380
For `ProcedureCallPacket<RowDataPacket[]>`, please see the following examples.
381381

382-
---
382+
<hr />
383383

384384
### OkPacket
385385

@@ -395,7 +395,7 @@ For `ProcedureCallPacket<RowDataPacket[]>`, please see the following examples.
395395
}
396396
/>
397397

398-
---
398+
<hr />
399399

400400
## Examples
401401

‎website/docs/examples/connections/create-connection.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ connection.addListener('error', (err) => {
5353
</TabItem>
5454
</Tabs>
5555

56-
---
56+
<hr />
5757

5858
## createConnection(config)
5959

@@ -102,7 +102,7 @@ connection.addListener('error', (err) => {
102102
</TabItem>
103103
</Tabs>
104104

105-
---
105+
<hr />
106106

107107
## createConnection(config) — SHA1
108108

@@ -148,7 +148,7 @@ connection.addListener('error', (err) => {
148148
</TabItem>
149149
</Tabs>
150150

151-
---
151+
<hr />
152152

153153
## createConnection(config) — SSL
154154

@@ -208,7 +208,7 @@ connection.addListener('error', (err) => {
208208
</TabItem>
209209
</Tabs>
210210

211-
---
211+
<hr />
212212

213213
## createConnection(config) — RDS SSL
214214

@@ -297,7 +297,7 @@ connectionquery('SHOW `status` LIKE "Ssl_cipher"', function (err, res) {
297297
- [#2119 — fix: make startTls code compatible with Bun](https://github.com/sidorares/node-mysql2/pull/2119)
298298
- [#2131 — Update Amazon RDS SSL CA cert](https://github.com/sidorares/node-mysql2/pull/2131)
299299

300-
---
300+
<hr />
301301

302302
## createConnection(config) — Socks
303303

@@ -379,7 +379,7 @@ connection.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
379379

380380
:::
381381

382-
---
382+
<hr />
383383

384384
## Glossary
385385

‎website/docs/examples/connections/create-pool.mdx‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Don't forget to release the connection when finished by using:
7070

7171
:::
7272

73-
---
73+
<hr />
7474

7575
## createPool(config)
7676

@@ -140,7 +140,7 @@ Don't forget to release the connection when finished by using:
140140

141141
:::
142142

143-
---
143+
<hr />
144144

145145
## createPool(config) — SHA1
146146

@@ -207,7 +207,7 @@ Don't forget to release the connection when finished by using:
207207

208208
:::
209209

210-
---
210+
<hr />
211211

212212
## createPool(config) — SSL
213213

@@ -288,7 +288,7 @@ Don't forget to release the connection when finished by using:
288288

289289
:::
290290

291-
---
291+
<hr />
292292

293293
## createPool(config) — RDS SSL
294294

@@ -398,7 +398,7 @@ Don't forget to release the connection when finished by using:
398398
- [#2119 — fix: make startTls code compatible with Bun](https://github.com/sidorares/node-mysql2/pull/2119)
399399
- [#2131 — Update Amazon RDS SSL CA cert](https://github.com/sidorares/node-mysql2/pull/2131)
400400

401-
---
401+
<hr />
402402

403403
## createPool(config) — Socks
404404

@@ -472,22 +472,24 @@ pool.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
472472

473473
:::
474474

475-
---
475+
<hr />
476476

477477
## Glossary
478478

479479
### PoolOptions
480480

481-
> **PoolOptions** extends all options from **ConnectionOptions**:
482-
>
483-
> <FAQ title='ConnectionOptions Specification'>
484-
> <ExternalCodeEmbed
485-
> language='ts'
486-
> url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
487-
> extractMethod='ConnectionOptions'
488-
> methodType='interface'
489-
> />
490-
> </FAQ>
481+
<blockquote>
482+
**PoolOptions** extends all options from **ConnectionOptions**:
483+
484+
<FAQ title='ConnectionOptions Specification'>
485+
<ExternalCodeEmbed
486+
language='ts'
487+
url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
488+
extractMethod='ConnectionOptions'
489+
methodType='interface'
490+
/>
491+
</FAQ>
492+
</blockquote>
491493

492494
<FAQ title='PoolOptions Specification'>
493495
<ExternalCodeEmbed

‎website/docs/examples/connections/createPoolCluster.mdx‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Don't forget to release the connection when finished by using:
7676

7777
:::
7878

79-
---
79+
<hr />
8080

8181
## add(group, config)
8282

@@ -152,7 +152,7 @@ Don't forget to release the connection when finished by using:
152152

153153
:::
154154

155-
---
155+
<hr />
156156

157157
## add(group, config) — SHA1
158158

@@ -225,7 +225,7 @@ Don't forget to release the connection when finished by using:
225225

226226
:::
227227

228-
---
228+
<hr />
229229

230230
## add(group, config) — SSL
231231

@@ -312,7 +312,7 @@ Don't forget to release the connection when finished by using:
312312

313313
:::
314314

315-
---
315+
<hr />
316316

317317
## add(group, config) — RDS SSL
318318

@@ -428,7 +428,7 @@ Don't forget to release the connection when finished by using:
428428
- [#2119 — fix: make startTls code compatible with Bun](https://github.com/sidorares/node-mysql2/pull/2119)
429429
- [#2131 — Update Amazon RDS SSL CA cert](https://github.com/sidorares/node-mysql2/pull/2131)
430430

431-
---
431+
<hr />
432432

433433
## add(group, config) — Socks
434434

@@ -512,22 +512,24 @@ poolNamespace.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
512512

513513
:::
514514

515-
---
515+
<hr />
516516

517517
## Glossary
518518

519519
### PoolOptions
520520

521-
> **PoolOptions** extends all options from **ConnectionOptions**:
522-
>
523-
> <FAQ title='ConnectionOptions Specification'>
524-
> <ExternalCodeEmbed
525-
> language='ts'
526-
> url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
527-
> extractMethod='ConnectionOptions'
528-
> methodType='interface'
529-
> />
530-
> </FAQ>
521+
<blockquote>
522+
**PoolOptions** extends all options from **ConnectionOptions**:
523+
524+
<FAQ title='ConnectionOptions Specification'>
525+
<ExternalCodeEmbed
526+
language='ts'
527+
url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
528+
extractMethod='ConnectionOptions'
529+
methodType='interface'
530+
/>
531+
</FAQ>
532+
</blockquote>
531533

532534
<FAQ title='PoolOptions Specification'>
533535
<ExternalCodeEmbed

0 commit comments

Comments
 (0)