Skip to content

Commit

Permalink
docs: polish the documentation website
Browse files Browse the repository at this point in the history
  • Loading branch information
wellwelwel committed Dec 5, 2023
1 parent 50c98a4 commit 2662d54
Show file tree
Hide file tree
Showing 4 changed files with 252 additions and 502 deletions.
6 changes: 5 additions & 1 deletion website/docs/contributing/website.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ See the [Stability Badges](/docs/stability-badges) for more detais.

{/* prettier-ignore-start */}
```tsx
import { History } from '@site/src/components/History';
import { Stability } from '@site/src/components/Stability';

<Stability level={2} />
<Stability level={2} message='Some message' />
Expand Down Expand Up @@ -159,6 +159,10 @@ import { FAQ } from '@site/src/components/FAQ';

## Running Tests

```bash
npm run test
```

<FAQ title='Check Prettier and ESLint rules for compliance'>

```bash
Expand Down
16 changes: 13 additions & 3 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ const config: Config = {
className: 'navbar__brand navbar__manual--title text--truncate',
activeBaseRegex: `^/$`,
},
{
to: '/docs/documentation',
label: 'Docs',
position: 'left',
},
{
to: '/docs/examples',
label: 'Examples',
Expand All @@ -74,7 +79,8 @@ const config: Config = {
position: 'left',
},
{
type: 'localeDropdown',
href: 'https://github.com/sidorares/node-mysql2',
label: 'GitHub',
position: 'right',
},
{
Expand All @@ -83,11 +89,15 @@ const config: Config = {
position: 'right',
},
{
href: 'https://github.com/sidorares/node-mysql2',
label: 'GitHub',
href: 'https://github.com/sponsors/sidorares',
label: 'Donate',
position: 'right',
},
{ type: 'search', position: 'right' },
{
type: 'localeDropdown',
position: 'right',
},
],
},
prism: {
Expand Down
Loading

0 comments on commit 2662d54

Please sign in to comment.