Quick Start

Already familiar with Node.js and the command line? Here’s the fastest path.

1. Make a Site and Run It

npx spaceclub new my-site
cd my-site
npm start

Your site is now running at http://localhost:8080. Changes you make to files in src/ (and to spaceclub.json) will auto-reload in the browser.

Where’s the rest of the code? Your site only holds your content and settings. The layouts, styles, and features come from the spaceclub package in node_modules/, so you get new features and fixes with npm update. See 6. Update.

2. Make It Yours

Open these files and change them to match your site:

File	What to Change
`src/_data/site.json`	Site title, description, logo, favicon, timezone, date format
`src/_data/navbar.json`	Navigation links (and which ones appear in the footer)
`spaceclub.json`	Colours, light or dark mode, navbar layout, footer, and which features your site has
`src/assets/images/`	Replace `logo.svg` and `favicon.svg` with your own

See Customisation for everything in spaceclub.json.

3. Edit Content

Homepage - Edit src/pages/home.md
About page - Edit src/pages/about.md
Contact page - Edit src/pages/contact.md
Add a page - Add a new .md file to src/pages/
Add a post - Copy src/posts/template.md, rename it, and edit the front matter and content
Add an event - Copy src/events/template.md, rename it, and edit the front matter and content

The two template.md files are example content, so change them to your own or delete them.

Rather click than type? Every site comes with SpaceDash, an editor at /admin/.

4. Build for Production

npm run build

This runs Eleventy to generate your site, then runs Pagefind to index it for search. The output goes to _site/ - that folder is your complete website, ready to upload anywhere.

5. Deploy

Your site includes a netlify.toml for one-click Netlify deployment. See Hosting and Deployment for all options including GitHub Pages and Vercel.

6. Update

New SpaceClub! versions bring features and fixes to your site without touching your content:

npm update spaceclub

What changed in each version is in node_modules/spaceclub/CHANGELOG.md.

Next Steps

Customisation - Colours, modes, navbar, footer, and branding
Events - Full event system documentation
Forms - How the contact form system works
Content Types - Your own kinds of content, like Team or Projects

SpaceClub!

Explorer