Surge

[slorber]

Note: I didn't write this platform guide. It was initially contributed to our website, and I extracted it here as part of our Deployment docs cleanup (#12139)

---

Deploying to Surge

Surge is a static web hosting platform that you can use to deploy your Docusaurus project from the command line in seconds. Deploying your project to Surge is easy and free (including custom domains and SSL certs).

Deploy your app in a matter of seconds using Surge with the following steps:

1. First, install Surge using npm by running the following command:

   npm install -g surge

2. To build the static files of your site for production in the root directory of your project, run:

   npm run build

3. Then, run this command inside the root directory of your project:

   surge build/

First-time users of Surge would be prompted to create an account from the command line (which happens only once).

Confirm that the site you want to publish is in the build directory. A randomly generated subdomain *.surge.sh subdomain is always given (which can be edited).

Using your domain {/* #using-your-domain */}

If you have a domain name you can deploy your site using the command:

surge build/ your-domain.com

Your site is now deployed for free at subdomain.surge.sh or your-domain.com depending on the method you chose.

Setting up CNAME file {/* #setting-up-cname-file */}

Store your domain in a CNAME file for future deployments with the following command:

echo subdomain.surge.sh > CNAME

You can deploy any other changes in the future with the command surge.