feat(docs): release documentation website (#2339)

* docs: resolve GitHub MDX parser conflict * docs: fix i18n home breadcrumb
sidorares · Jan 7, 2024 · c0d77c0 · c0d77c0
1 parent 323ab12
commit c0d77c0
Show file tree

Hide file tree

Showing 22 changed files with 109 additions and 105 deletions.
diff --git a/website/docs/contributing/website.mdx b/website/docs/contributing/website.mdx
@@ -11,15 +11,15 @@ import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';
 
 This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
 
----
+<hr />
 
 ## Environment
 
 You will need these tools installed on your system:
 
 - [Node.js (18.x or higher)](https://nodejs.org/)
 
----
+<hr />
 
 ## Development
 
@@ -58,7 +58,7 @@ Note that the website has its own _package.json_.
 Please, do not install dependencies for the website in **node-mysql2** root.
 :::
 
----
+<hr />
 
 ## Extras Components
 
@@ -100,7 +100,7 @@ You can also utilize React components in the `changes` option.
   />
 </FAQ>
 
----
+<hr />
 
 ### Stability
 
@@ -126,7 +126,7 @@ Available levels: `0`, `1`, `1.1`, `1.2`, `2` and `3`.
   <Stability level={2} message='Some message.' />
 </FAQ>
 
----
+<hr />
 
 ### FAQ
 
@@ -157,7 +157,7 @@ import { FAQ } from '@site/src/components/FAQ';
   </FAQ>
 </FAQ>
 
----
+<hr />
 
 ### ExternalCodeEmbed
 
@@ -193,7 +193,7 @@ import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';
   />
 </FAQ>
 
----
+<hr />
 
 ## Running Tests
 

diff --git a/website/docs/documentation/00-index.mdx b/website/docs/documentation/00-index.mdx
@@ -29,13 +29,13 @@ Not only **MySQL2** offers better performance over [Node MySQL][node-mysql], we
 - MySQL Compression
 - Binary Log Protocol Client
 
----
+<hr />
 
 ## Examples
 
 Please check these [examples](/docs/examples) for **MySQL2**.
 
----
+<hr />
 
 ## Known incompatibilities with [Node MySQL][node-mysql]
 
@@ -54,7 +54,7 @@ Please check these [examples](/docs/examples) for **MySQL2**.
 This option could lose precision on the number as Javascript Number is a Float!
 :::
 
----
+<hr />
 
 ## Other Resources
 
@@ -64,7 +64,7 @@ This option could lose precision on the number as Javascript Number is a Float!
 - [node-libmysqlclient](https://github.com/Sannis/node-mysql-libmysqlclient) - Bindings to libmysqlclient
 - [go-mysql](https://github.com/siddontang/go-mysql) - MySQL Go client (prepared statements, binlog protocol, server)
 
----
+<hr />
 
 ## Benchmarks
 

diff --git a/website/docs/documentation/mysql-server.mdx b/website/docs/documentation/mysql-server.mdx
@@ -10,7 +10,7 @@
 - **connect**
   - new incoming connection.
 
----
+<hr />
 
 ## Connection
 

diff --git a/website/docs/documentation/typescript-examples.mdx b/website/docs/documentation/typescript-examples.mdx
@@ -16,7 +16,7 @@ npm install --save-dev @types/node
 Requires **TypeScript** `>=4.5.2`.
 :::
 
----
+<hr />
 
 ## Usage
 
@@ -90,7 +90,7 @@ The `rows` output will be these possible types:
 
 In this example, you need to manually check the output types
 
----
+<hr />
 
 ## Type Specification
 
@@ -156,7 +156,7 @@ conn.query<RowDataPacket[]>('SHOW TABLES FROM `test`;', (_err, rows) => {
 });
 ```
 
----
+<hr />
 
 ### RowDataPacket[][]
 
@@ -186,7 +186,7 @@ conn.query<RowDataPacket[][]>(sql, (_err, rows) => {
 });
 ```
 
----
+<hr />
 
 ### ResultSetHeader
 
@@ -244,7 +244,7 @@ conn.query<ResultSetHeader>(sql, (_err, result) => {
 });
 ```
 
----
+<hr />
 
 ### ResultSetHeader[]
 
@@ -306,7 +306,7 @@ conn.query<ResultSetHeader[]>(sql, (_err, results) => {
 });
 ```
 
----
+<hr />
 
 ### ProcedureCallPacket
 
@@ -379,7 +379,7 @@ By using `SELECT` and `SHOW` queries in a **Procedure Call**, it groups the resu
 
 For `ProcedureCallPacket<RowDataPacket[]>`, please see the following examples.
 
----
+<hr />
 
 ### OkPacket
 
@@ -395,7 +395,7 @@ For `ProcedureCallPacket<RowDataPacket[]>`, please see the following examples.
   }
 />
 
----
+<hr />
 
 ## Examples
 

diff --git a/website/docs/examples/connections/create-connection.mdx b/website/docs/examples/connections/create-connection.mdx
@@ -53,7 +53,7 @@ connection.addListener('error', (err) => {
   </TabItem>
 </Tabs>
 
----
+<hr />
 
 ## createConnection(config)
 
@@ -102,7 +102,7 @@ connection.addListener('error', (err) => {
   </TabItem>
 </Tabs>
 
----
+<hr />
 
 ## createConnection(config) — SHA1
 
@@ -148,7 +148,7 @@ connection.addListener('error', (err) => {
   </TabItem>
 </Tabs>
 
----
+<hr />
 
 ## createConnection(config) — SSL
 
@@ -208,7 +208,7 @@ connection.addListener('error', (err) => {
   </TabItem>
 </Tabs>
 
----
+<hr />
 
 ## createConnection(config) — RDS SSL
 
@@ -297,7 +297,7 @@ connectionquery('SHOW `status` LIKE "Ssl_cipher"', function (err, res) {
   - [#2119 — fix: make startTls code compatible with Bun](https://github.com/sidorares/node-mysql2/pull/2119)
   - [#2131 — Update Amazon RDS SSL CA cert](https://github.com/sidorares/node-mysql2/pull/2131)
 
----
+<hr />
 
 ## createConnection(config) — Socks
 
@@ -379,7 +379,7 @@ connection.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
 
 :::
 
----
+<hr />
 
 ## Glossary
 

diff --git a/website/docs/examples/connections/create-pool.mdx b/website/docs/examples/connections/create-pool.mdx
@@ -70,7 +70,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## createPool(config)
 
@@ -140,7 +140,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## createPool(config) — SHA1
 
@@ -207,7 +207,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## createPool(config) — SSL
 
@@ -288,7 +288,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## createPool(config) — RDS SSL
 
@@ -398,7 +398,7 @@ Don't forget to release the connection when finished by using:
   - [#2119 — fix: make startTls code compatible with Bun](https://github.com/sidorares/node-mysql2/pull/2119)
   - [#2131 — Update Amazon RDS SSL CA cert](https://github.com/sidorares/node-mysql2/pull/2131)
 
----
+<hr />
 
 ## createPool(config) — Socks
 
@@ -472,22 +472,24 @@ pool.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
 
 :::
 
----
+<hr />
 
 ## Glossary
 
 ### PoolOptions
 
-> **PoolOptions** extends all options from **ConnectionOptions**:
->
-> <FAQ title='ConnectionOptions Specification'>
->   <ExternalCodeEmbed
->     language='ts'
->     url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
->     extractMethod='ConnectionOptions'
->     methodType='interface'
->   />
-> </FAQ>
+<blockquote>
+  **PoolOptions** extends all options from **ConnectionOptions**:
+
+  <FAQ title='ConnectionOptions Specification'>
+    <ExternalCodeEmbed
+      language='ts'
+      url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
+      extractMethod='ConnectionOptions'
+      methodType='interface'
+    />
+  </FAQ>
+</blockquote>
 
 <FAQ title='PoolOptions Specification'>
   <ExternalCodeEmbed

diff --git a/website/docs/examples/connections/createPoolCluster.mdx b/website/docs/examples/connections/createPoolCluster.mdx
@@ -76,7 +76,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## add(group, config)
 
@@ -152,7 +152,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## add(group, config) — SHA1
 
@@ -225,7 +225,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## add(group, config) — SSL
 
@@ -312,7 +312,7 @@ Don't forget to release the connection when finished by using:
 
 :::
 
----
+<hr />
 
 ## add(group, config) — RDS SSL
 
@@ -428,7 +428,7 @@ Don't forget to release the connection when finished by using:
   - [#2119 — fix: make startTls code compatible with Bun](https://github.com/sidorares/node-mysql2/pull/2119)
   - [#2131 — Update Amazon RDS SSL CA cert](https://github.com/sidorares/node-mysql2/pull/2131)
 
----
+<hr />
 
 ## add(group, config) — Socks
 
@@ -512,22 +512,24 @@ poolNamespace.execute('SELECT SLEEP(1) AS `qqq`', (err, rows, fields) => {
 
 :::
 
----
+<hr />
 
 ## Glossary
 
 ### PoolOptions
 
-> **PoolOptions** extends all options from **ConnectionOptions**:
->
-> <FAQ title='ConnectionOptions Specification'>
->   <ExternalCodeEmbed
->     language='ts'
->     url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
->     extractMethod='ConnectionOptions'
->     methodType='interface'
->   />
-> </FAQ>
+<blockquote>
+  **PoolOptions** extends all options from **ConnectionOptions**:
+
+  <FAQ title='ConnectionOptions Specification'>
+    <ExternalCodeEmbed
+      language='ts'
+      url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/typings/mysql/lib/Connection.d.ts'
+      extractMethod='ConnectionOptions'
+      methodType='interface'
+    />
+  </FAQ>
+</blockquote>
 
 <FAQ title='PoolOptions Specification'>
   <ExternalCodeEmbed