V3

Use this guide to migrate your project from Thulite v2 to Thulite v3.

Prerequisites

Updating

Follow the steps below to update your project.

  1. Remove currently installed dependencies to avoid version conflicts:

    npm run clean:install

    pnpm run clean:install

    yarn run clean:install

    bun run clean:install

  2. Update package.json

    Replace the contents of your project’s package.json with the following template:

    {
  "name": "thulite-project",
  "version": "0.0.0",
  "description": "Thulite",
  "author": "Thulite",
  "license": "MIT",
  "scripts": {
    "create": "hugo new",
    "dev": "hugo server --disableFastRender --noHTTPCache",
    "portless": "portless run thulite-portless",
    "format": "prettier **/** -w -c",
    "build": "hugo --minify --gc",
    "preview": "vite preview --outDir public"
  },
  "engines": {
    "node": ">=20.11.0"
  }
}

  3. Install the latest Thulite dependency in your project:

    npm install thulite@latest

    pnpm install thulite@latest

    yarn add thulite@latest

    bun install thulite@latest

  4. Install the latest versions of Portless, Prettier, and Vite as devDependencies:

    npm install -D portless@latest prettier@latest vite@latest

    pnpm install -D portless@latest prettier@latest vite@latest

    yarn add -D portless@latest prettier@latest vite@latest

    bun add -D portless@latest prettier@latest vite@latest

  5. Optionally, install the recommended integrations in your project:

    npm install @thulite/images@latest @thulite/seo@latest

    pnpm install @thulite/images@latest @thulite/seo@latest

    yarn add @thulite/images@latest @thulite/seo@latest

    bun install @thulite/images@latest @thulite/seo@latest

After upgrading Thulite to the latest version, you may not need to make any changes to your project at all!

If you notice errors or unexpected behavior, review the sections below to identify project changes you may still need to make.

Configuration

Review your project configuration for Thulite and the recommended integrations:

Known Issues

ENOENT

If you get an ENOENT error, run the following command:

npm run clean:install && npm install

pnpm run clean:install && pnpm install

yarn run clean:install && yarn install

bun run clean:install && bun install