Skip to content

An example of how to set your Docusaurus instance up to enable deployment on Kinsta App Hosting services.

License

Notifications You must be signed in to change notification settings

kinsta/hello-world-docusaurus

Repository files navigation

Kinsta - Hello World - Docusaurus

An example of how to deploy a static site built with Docusaurus on Kinsta Hosting.


Kinsta is a developer-centric cloud host / PaaS. We’re striving to make it easier for you to share your web projects with your users. You can focus on coding and building, and we'll take care of deployments with fast, scalable hosting.

At Kinsta, Static Sites are free, and you can host up to 100 sites on your account for completely free.

Kinsta offers 24/7 support via our chat system, which is always one click away in MyKinsta for customers with a paid plan or service.

If you only have a Static Site Hosting account, we have detailed Static Site Hosting documentation available. You can also connect with developers and knowledgeable community members in the Kinsta Community forum.

Setup

Static Site Hosting [click to expand]

Dependency Management

Kinsta automatically installs dependencies defined in your package.json file during the deployment process.

Setting the Build Command, Node version, and Publish directory

After connecting the repository, Static Site Hosting will automatically try to populate all the fields with the correct values.

Configuration option Value
Build command npm run build
Node version 16.20
Publish directory build

Deployment Lifecycle

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

Application Hosting [click to expand]

Dependency Management

Kinsta automatically installs dependencies defined in your package.json file during the deployment process.

Port

Kinsta automatically sets the PORT environment variable. You should not define it yourself and you should not hard-code it into the application. The serve package utilizes the port set by Kinsta automatically.

Start Command

When deploying an application, Kinsta automatically creates a web process with npm start as the entry point. Make sure to use this command to run your server.

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.

What is Docusaurus

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.

About

An example of how to set your Docusaurus instance up to enable deployment on Kinsta App Hosting services.

Topics

Resources

License

Stars

Watchers

Forks