Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://sidorares.github.io/node-mysql2/docs/contributing/website below:

Documentation Site | Quickstart

This website is built using Docusaurus 3, a modern static website generator.

You will need these tools installed on your system:

• Node.js (18.x or higher)

1. Fork the MySQL2 repository.
2. Download your forked repository locally. The website's workspace is the "website" directory in node-mysql2 root.
3. Create a new branch from master (optional).
4. Run cd website to enter the website workspace.
5. Run npm ci to install the dependecies from package-lock.json.
6. Run npm start to starting the local development.

It will start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

For Docusaurus complete documentation, please see here.

git clone https://github.com/sidorares/node-mysql2.git
git checkout -b website 
cd /path-to/node-mysql2/website
npm ci
npm start

Documentation is auto-generated from MDX files placed in these directories:

• ./docs/documentation
• ./docs/examples
• ./docs/faq

Caution

Note that the website has its own package.json.

Please, do not install dependencies for the website in node-mysql2 root.

Every extra component is thoroughly documented with complete typings descriptions.

Docusaurus Markdown Features: The MDX compiler transforms Markdown files to React components, and allows you to use JSX in your Markdown content. This enables you to easily interleave React components within your content, and create delightful learning experiences.

The History component displays version changes in a table format, listing version numbers alongside their changes.

import { History } from '@site/src/components/History';

<History
  records={[
    {
      version: '1.0.0',
      changes: ['Some change message.'],
    },
  ]}
/>

tip

You can also utilize React components in the changes option.

See the Stability Badges for more detais.

import { Stability } from '@site/src/components/Stability';

<Stability level={2} />
<Stability level={2} message='Some message' />

tip

You can also utilize React components in the message option.

Available levels: 0, 1, 1.1, 1.2, 2 and 3.

import { FAQ } from '@site/src/components/FAQ';

<FAQ title='Title'>

  > Some markdown (**MDX**) content.

</FAQ>

tip

• The FAQ component can be utilized in any section or page.
• Code blocks are compatible and can be used within the FAQ component.

Some markdown (MDX) content.

import { ExternalCodeEmbed } from '@site/src/components/ExternalCodeEmbed';

<ExternalCodeEmbed
  url='https://github.com/sidorares/node-mysql2/blob/75b05f0765c9edd0c0be8f18d85be05618770cca/.prettierrc'
  language='json'
/>

<ExternalCodeEmbed
  url='https://raw.githubusercontent.com/sidorares/node-mysql2/master/tools/parse-row.js'
  language='js'
  extractMethod='parseC'
  methodType='function'
/>

• Included in the GitHub Actions workflow.

Checks for MDX components are missing.

• Included in the GitHub Actions workflow.

npm run clear
npm run build

• Included in the GitHub Actions workflow.

• To prevent lint issues, it is recommended to execute this command before creating your commit.
• Not included in the GitHub Actions workflow.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4