Quick Start

  1. Initialize a new remix project:

    npx create-remix@latest
    

    Choose "Just the basics" and the "Remix App Server" when prompted.

  2. Install remix-ssg and serve to serve the static assets:

    npm install -D remix-ssg serve
    
  3. Update your package.json scripts to use remix-ssg instead of remix and serve instead of remix-serve:

    {
      "scripts": {
        "build": "remix-ssg public",
        "dev": "remix dev",
        "start": "serve -l 3000 public"
      }
    }
    
  4. Add a getStaticPaths export to your routes. For example app/routes/index.tsx may look like:

    export function getStaticPaths() {
      return ["/"];
    }