Lumio Theme Documentation

Installation Guide

Follow these steps to set up and start using the theme.

Prerequisites

Before you begin, ensure your system meets the following requirements.

Tip

If you’re on macOS, the easiest way to install dependencies is using Homebrew. Homebrew is a package manager that simplifies installing software. Follow this guide to install Homebrew.

Install Node.js

Lumio requires Node.js 22.12.0 or later. The theme uses modern Astro and Tailwind tooling, so using the version declared in package.json is the safest path.

Windows

Follow these steps to install Node.js on Windows:

1. Download the latest suitable LTS/current version of Node.js from the official website: Node.js Downloads
2. Run the installer after it’s downloaded, and follow the on-screen instructions.
3. After installation, open the Command Prompt and verify the installation:

node -v

You should see a version number like v22.12.0 or newer.

Tip

If you run into any issues, you can use Chocolatey to install Node.js:

choco install nodejs-lts

macOS

Here’s how to install Node.js on macOS:

1. Make sure Homebrew is installed.
2. Open Terminal and run:

brew install node

3. Verify the installation:

node -v

The terminal should display the installed version of Node.js.

Tip

You can also download the installer directly from Node.js Downloads if you prefer not to use Homebrew.

Linux

To install Node.js on Linux, follow these steps:

1. Open Terminal and update your package list:

sudo apt update

2. Install Node.js:

sudo apt install nodejs npm

3. Verify the installation:

node -v

If everything worked correctly, the installed version will be displayed.

Tip

For other Linux distributions, check the official Node.js installation guide for the recommended package source.

💡 Need help? Check out the official Node.js installation guide.

---

Setting Up Lumio

Once Node.js is installed, follow these steps to set up Lumio:

Install Dependencies

Navigate to your project directory and run:

npm install

This will install all dependencies for Lumio.

Start the Development Server

To start the local development server, run:

npm run dev

Lumio’s dev script also starts the TOML watcher, so updates to src/config/config.toml are reflected in the generated config used by the app.

Create a Production Build

To generate an optimized production build, run:

npm run build

This will generate the site, process multilingual/config helpers, and place the final output in the dist/ folder.

Preview the Production Build

To preview the built site locally, run:

npm run preview

This lets you verify the production output before deployment.

---

🚀 You’re all set. Next, review the project structure so you know where Lumio keeps its content, layouts, and configuration.