Docusaurus

This is an example of how to set up a static site with Docusaurus on Kinsta’s Static Site Hosting services from a GitHub repository.

Docusaurus is a static-site generator specializing in producing documentation websites that are simple to build with minimal coding experience required so you can use it out of the box. More information is available on the Docusaurus website.

You can also use this quick start template on Kinsta’s Application Hosting without any additional configuration. If you use Application Hosting, the Start command can be left blank for the web process as Kinsta automatically detects the required command during the first deployment.

Prerequisites

• Kinsta’s quick start templates are stored and managed in GitHub; therefore, you need a GitHub account to access them.
• You need to create a MyKinsta account to deploy the application.

Deploy a Docusaurus Static Site

1. Log in to GitHub and create a new repository from this template (Use this template > Create a new repository): Kinsta – Hello World – Docusaurus.
2. In MyKinsta, click Static Sites > Add site > select GitHub, click Connect git provider > Authorize, and log in to your GitHub account.
3. Choose the Hello World Docusaurus repository, click Continue, and enter the following in the Build settings:
   • Build command: npm run build
   • Node version: 18.16.0
   • Publish directory: build

During the deployment process, Kinsta automatically installs dependencies defined in your package.json file. The site is available as soon as the deployment finishes, and the Docusaurus default page loads at your site’s URL.

Deployment Lifecycle

Whenever a deployment is initiated (through creating an application or re-deploying due to an incoming commit), the npm build command is run, followed by the npm start command.