Installation

Prerequisites

Lume requires Node v24 LTS or newer, so make sure to have it installed if you haven't already done so.

Setup Lume

To create a Lume project faster, run the following command:

npm create lume

pnpm create lume

yarn create lume

This command installs Lume and create the following files:

_config.ts

Lume's configuration file, where you can customize the site build.

package.json

The NPM dependencies and a couple of scripts: serve (to start a development server) and build (to build the site for production).

tsconfig.json

TypeScript configuration file with some configuration required by Lume. Useful to use TypeScript and TSX to build your site.

index.md

A markdown file with a simple "hello world" that servers as a demonstration.