Quickstart

Create your first Marque site in minutes.

Requirements

You will be installing Marque in your terminal (What's a terminal?).

Before installing Marque, make sure you have:

Check your versions:

sh
  node -v # >= v20.19.0
  npm -v

Installation

Install from source (recommended)

Install the marque package directly from GitHub:

sh
  npm install -g github:Loxed/marque

This makes the marque command available globally.

Verify installation

sh
marque --help

If the command runs, you're ready to go.

Create and run your site

Create a new site

Go to the directory where you want to create your site and run:

sh
marque new my-site
cd my-site # change into the new site's directory

Start the dev server

Run the local server with live reload:

sh
marque serve .

Then open http://localhost:3000.

Edit content

Modify files inside pages/.
Changes are reflected instantly in your browser.

Build for production

Generate static files:

sh
marque build .

Output is written to dist/.

Windows Users

Make sure you use the correct workspace for your CLI tool!

  • If you’re using WSL, clone the project inside the WSL filesystem (/home/username/...)
  • If you’re using CMD or PowerShell, keep it on the Windows filesystem.

Running the project on the Windows filesystem with WSL (mnt/c/...) can cause significant performance issues!