Skip to main content
Kinsta.comCommunityOpens in a new tabMyKinstaOpens in a new tab

Docsify

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

Docsify is a documentation generator that generates your documentation website on the fly from Markdown files in your repository’s docs directory. More information is available on the docsify.js.org 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 Docsify 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 – Static Site With Docsify.
  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 Docsify repository, click Continue, in the Build settings, make sure that the Build command and Node version are blank and the Publish directory is set to docs, and click Create site.

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 Docsify Welcome page loads at your site’s URL.

Docsify Welcome page after successful deployment of Docsify.
Docsify Welcome page after successful deployment of Docsify.

Deployment Lifecycle

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