Deploying a Docusaurus App

Docusaurus is a modern static site generator designed for building documentation websites quickly and easily. It features Markdown support, versioning, and a rich plugin ecosystem, making it ideal for open-source and product documentation.

This guide explains how to deploy a Docusaurus application to Klutch.sh, both with and without a Dockerfile. It covers installation, sample code, and deployment steps.

Prerequisites

• Node.js & npm installed (Download)
• Git and GitHub account
• Klutch.sh account

---

Getting Started: Create a Docusaurus App

1. Create a new Docusaurus app:

   npx create-docusaurus@latest my-docusaurus-app classic
   cd my-docusaurus-app
   npm install

2. Start the development server:

   npm run start

   Your app should be running at http://localhost:3000.

Sample Code (docs/hello-klutch.md)

Create a sample doc page:

---
id: hello-klutch
title: Hello from Docusaurus on Klutch.sh!
---

Welcome to your Docusaurus site deployed on Klutch.sh!

---

Deploying Without a Dockerfile

Docusaurus apps are static sites after build. Klutch.sh can deploy static sites directly.

1. Push your Docusaurus app to a GitHub repository.
2. Log in to Klutch.sh.
3. Create a new project.
4. Create a new app:
   • Select your Docusaurus GitHub repository and branch
   • Choose “Static Site” as the app type
   • Set build command: npm run build
   • Set output directory: build
   • Configure region, compute, and environment variables as needed
5. Click “Create” to deploy. Klutch.sh will build and serve your static Docusaurus app.

---

Deploying With a Dockerfile

If you need custom server logic or want to use a Dockerfile:

1. Add a Dockerfile to your project root. Example:

   # Build stage
   FROM node:20-alpine AS builder
   WORKDIR /app
   COPY package*.json ./
   RUN npm install
   COPY . .
   RUN npm run build
   
   # Production stage
   FROM nginx:alpine
   COPY --from=builder /app/build /usr/share/nginx/html
   EXPOSE 80
   CMD ["nginx", "-g", "daemon off;"]

2. Push your code (with Dockerfile) to GitHub.
3. In Klutch.sh, create a new app and select the Dockerfile option when prompted.
4. Set service details and environment variables as needed.
5. Click “Create” to deploy. Klutch.sh will build your Docker image and serve your Docusaurus app via Nginx.

---

Resources

• Klutch.sh Documentation
• Docusaurus Documentation

---

Deploying Docusaurus to Klutch.sh is fast and flexible. Use static site deployment for most cases, or Dockerfile for custom setups.