eMondrian Docs

Deployment Guide

1 min read

☁️ Production Deployment Guide

This document contains step-by-step instructions for compiling and serving the static Quartz documentation on a target web server.

📦 Building the Project

Quartz v5 builds are run autonomously on the server via the CLI:

# Install up-to-date plugins
npm run install-plugins
 
# Trigger production compilation
npm run build

Once compilation completes, all static HTML, CSS, and JS assets will reside in the public/ directory.

🌐 Web Server Configuration (Nginx)

To serve static assets from the public/ output directory, configure your Nginx server block:

server {
    listen 80;
    server_name docs.example.com;
 
    root /Users/ssemenkoff/Projects/BIS/Docs/public;
    index index.html;
 
    location / {
        try_files $uri $uri/ =404;
    }
 
    # Cache static assets
    location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg|woff|woff2)$ {
        expires 30d;
        add_header Cache-Control "public, no-transform";
    }
}

🧱 Architectural Relationship

The deployment pipeline is closely aligned with the underlying services config defined in the System Architecture overview.

Back to Guides.

Tags: deploy nginx production

Backlinks