This guide will show you how to deploy a Docusaurus site and get your domain set up.
Docusaurus is a documentation framework that enables you to maintain open-source documentation websites. This guide covers how to deploy a Docusaurus v2 site. To build an Docusaurus site, start with a template:
Deploy Docusaurus to Vercel
Vercel is a platform for deploying the fastest Docusaurus sites. You can deploy your site with zero configuration to the best frontend infrastructure.
- Develop: Build Docusaurus sites that connect to your favorite APIs, databases, and content management systems.
- Preview: Integrate with any GitHub, GitLab, or Bitbucket repository for instant continuous deployment.
- Ship: Deploy your site to every edge node worldwide for the fastest Docusaurus sites. Static files, Serverless and Edge Functions, and more.
Built-in CI/CD for Docusaurus sites
Vercel has integrations for GitHub, GitLab, and Bitbucket to enable CI/CD for your Docusaurus site with zero configuration. Then, you can run automated tests for performance and reliability on every push. Pull and merge requests are deployed instantly to a unique URL, accessible to your entire team.
Add your custom domain
After deploying, your new Docusaurus site will get automatically assigned a .vercel.app suffixed domain. You can then add a Custom Domain on your choice, either from a third-party or purchased through Vercel.
Deploy Docusaurus to Vercel
Start from a template
Vercel CLI
- Install the Vercel CLI and run
vercelto deploy. - Vercel will detect that you are using Docusaurus and will enable the correct settings for your deployment.
- Your site is deployed! (e.g. docusaurus-2-template.vercel.app)
Vercel for Git
- Push your code to your git repository (GitHub, GitLab, BitBucket).
- Import your Docusaurus project into Vercel.
- Vercel will detect that you are using Docusaurus and will enable the correct settings for your deployment.
- Your site is deployed! (e.g. docusaurus-2-template.vercel.app)