This is an example of how to set up a static site with Docusaurus on Kinsta’s Application or 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.
During the deployment process, Kinsta automatically installs dependencies defined in your package.json file.
Static Site Hosting
- Log in to GitHub and create a new repository from this template (Use this template > Create a new repository): Kinsta – Hello World – Docusaurus
- In MyKinsta, add a static site with the Hello World Docusaurus repository and the following Build settings:
- Build command:
npm run build
- Node version: 18.16.0
- Publish directory: build
- Build command:
- The site is available as soon as the build finishes, and the Docusaurus default page loads at your site’s URL.
Application Hosting
- Log in to GitHub and create a new repository from this template (Use this template > Create a new repository): Kinsta – Hello World – Docusaurus
- In MyKinsta, add an application with the Hello World Docusaurus repository. The Start command can be left blank for the web process as Kinsta automatically detects the required command during the first deployment.
- The app is available as soon as the build finishes, and the Docusaurus default page loads at your application’s URL.
Web Server Setup
Port
Kinsta automatically sets the PORT
environment variable. You do not need to define it or hard-code it into the application. The serve package utilizes the port set by Kinsta automatically.
Start Command
When you deploy the application, Kinsta automatically creates a web process with npm start
as the Start command.
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.
Docusaurus Default Page
The app or site is available as soon as the build finishes, and a default Docusaurus page loads at your application’s URL or static site’s URL.
