Quickstart
Get from zero to a running site in a few minutes.
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!
Requirements
Before installing Marque, make sure you have:
- Node.js 18 or newer
- npm (comes with Node.js)
Check your versions:
sh
node -v # >= v18.0.0
npm -vInstallation
Install from source (recommended)
Install the marque package directly from github
sh
npm install -g github:Loxed/marqueThis makes the marque command available globally.
Verify installation
sh
marque --helpIf the command runs, you're ready to go.
Create and run your site
Create a project
Scaffold a new site:
sh
marque new my-site
cd my-siteStart 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/.