The Docusaurus Example is a boilerplate template from Vercel that provides a minimal Docusaurus site configured for deployment to Vercel with zero configuration.
What is the Docusaurus Example?
The Docusaurus Example is a starter project that demonstrates how to deploy a Docusaurus static site on Vercel. It takes a fresh Docusaurus project created with the Docusaurus CLI and makes it ready for one-click deployment. The output is a live static site served by Vercel's global edge network. Vercel maintains this example as part of their framework boilerplates collection.
Key Features
- Zero configuration deployment — Push the repository to Vercel or use the Deploy with Vercel button; no build settings are required because Vercel auto-detects Docusaurus.
- One-click deploy — The included Deploy button clones the repo and starts a new Vercel project directly from the browser.
- Live reference site — A running example is available at https://docusaurus-template.vercel.app.
- CLI initialization — The project can be reproduced locally by running
docusaurus-initin a terminal. - Part of Vercel examples — This boilerplate lives in the vercel/examples repository, which contains curated patterns for building apps at scale.
- Docusaurus framework — The site uses Docusaurus, a React-based static site generator commonly used for documentation, blogs, and project landing pages.
Who is it for?
- Developers deploying Docusaurus sites — Use this template to skip Vercel build configuration and go straight to production.
- Documentation maintainers — Start with this example to publish documentation sites on a global CDN with automatic previews.
- Teams evaluating Vercel — Clone the boilerplate to see how an existing Docusaurus project behaves when deployed to Vercel.
What can you do with the Docusaurus Example?
- Create a docs site: Replace the default Docusaurus content with your own markdown files to publish documentation.
- Test Vercel workflows: Deploy the template to experiment with preview deployments, environment variables, and custom domains.
- Learn Docusaurus structure: Explore the generated project layout to understand how Docusaurus pages, sidebar, and configuration files are organized.
How does the Docusaurus Example work?
The repository contains a standard Docusaurus project. To use it, either click the Deploy with Vercel button to create a new project from the template, or run docusaurus-init locally to generate the same structure. Once deployed, Vercel automatically detects the Docusaurus build command and output directory.
FAQ
Do I need to configure anything to deploy this template?
No. Vercel auto-detects Docusaurus and applies the correct build settings, so the template deploys exactly as-is.
Is the Docusaurus Example free to use?
The template code is open source as part of the vercel/examples repository. Deploying to Vercel uses Vercel's hosting plans; a hobby tier is available for non-commercial projects.
Can I use this for a blog?
Yes. Docusaurus supports blog posts, and this example can be extended to include a blog section alongside documentation pages.
How do I create this project locally without Vercel?
Run the Docusaurus CLI command docusaurus-init in your terminal to generate a new Docusaurus site locally, then push it to any git provider and import it to Vercel.
