Altair Astro documentation
Getting started
Install Altair, run it on your computer and publish your first version in about ten minutes.
Looking for a different Astro theme? See all our Astro themes.
Thanks for choosing Altair. This guide takes you from the downloaded zip to a site running on your computer. The rest of the documentation covers every setting in detail, but you can get a long way with just this page.
Requirements
- Node.js 22.12 or newer. Check your version with
node -v. If you need to install or upgrade, get the LTS version from nodejs.org. - A code editor. Any editor works. VS Code will offer to install the official Astro extension, which adds syntax highlighting and autocomplete.
- Basic comfort with a terminal. You only need three commands.
Install
- Unzip
altair-astro-v1.0.0.zipand move thealtair-astrofolder wherever you keep your projects. Rename it if you like. - Open a terminal in that folder and install the dependencies:
npm install
Run it locally
npm run dev
Open http://localhost:4321 in your browser. The page reloads by itself every time you save a file, so keep it open while you edit.
Make it yours in five steps
- Your details. Open
src/site.config.tsand change the name, title, email, location, time zone and social links. See Site settings. - Your color. Change
accentin the same file. Everything follows it. - Your portrait. Replace
src/assets/portrait.svgwith your photo, or import a new file in the config. - Your projects. Edit the Markdown files in
src/content/projects/. See Projects and lists. - Your domain. Set
siteinastro.config.mjsto your own address, for examplehttps://example.com.
Build and publish
npm run build
This creates a dist folder with your finished site: plain HTML, CSS and images. Upload it to any static host, or connect your repository to one so it rebuilds on every change. Deploying has step-by-step instructions.
Commands
| Command | What it does |
|---|---|
npm install |
Installs the dependencies. Run it once, and again after updating. |
npm run dev |
Starts the local preview at localhost:4321. |
npm run build |
Builds the finished site into dist/. |
npm run preview |
Serves the built dist/ folder so you can check it before publishing. |
npm run check |
Checks your code and content for errors. |