Installation

Prerequisites

Before you begin, make sure you have the following installed on your system:

• Node.js version 22.12 or newer
• npm version 9.6 or newer (npm 10+ recommended)

You can verify your versions by running:

node --version
npm --version

Install Dependencies

Clone the repository and install the required packages:

git clone https://github.com/your-username/your-repo.git
cd your-repo
npm install

Start the Development Server

Run the following command to start the local development server:

npm run dev

The site will be available at http://localhost:4321. The dev server supports hot reloading, so changes to your content and components will appear immediately.

Build for Production

When you are ready to deploy, create a production build:

npm run build

This generates the static site in the dist/ directory and also runs Pagefind to create the search index.

Preview the Build

To preview the production build locally before deploying:

npm run preview

Next Steps

Once the project is running, head to the Configuration guide to customize the site for your brand.