Atlas
1.2k Get started
Get started 1.2k
☰ Contents

Installation

🚀 Getting started Updated: August 20, 2026

Run Atlas locally in five minutes – with npm, without external services.

Requirements

Atlas needs only two things on your machine:

ToolVersionCheck with
Node.js22 or newernode -v
npm10 or newernpm -v

No external fonts, CDNs or analytics are loaded. Installation works fully offline once the packages are cached.

Create the project

npm create astro -- --template JUNGHERZ/NotionKit-Web atlas
cd atlas
npm install
npm run dev

The dev server answers at http://localhost:4321/. Changes to Markdown files show up immediately.

First adjustments

  1. src/data/site.ts – name, description, languages.
  2. src/styles/brand.css – brand colour, optional serif headlines.
  3. src/content/docs/ – replace these pages with your own.
💡
The theme choice is stored locally in the browser only. There is no server that knows anything about visitors.

Build and publish

npm run build      # static site into dist/
npm run preview    # check locally
npm test           # smoke tests: themes, mobile, no-JS

A push to main triggers the GitHub Actions workflow: test, build, deploy to GitHub Pages.