Lena OkaforRD

Maia docs

Getting started

Install Maia, run it on your computer and publish your practice website, step by step.

Thanks for choosing Maia. This guide takes you from the downloaded zip to your own site running on your computer. You don’t need to be a developer: most changes are made in plain text files.

Requirements

  • Node.js 22.12 or newer. Check your version by typing node -v in a terminal. If you need to install or update it, download the LTS version from nodejs.org.
  • A code editor. VS Code is free and offers to install the Astro extension, which highlights mistakes as you type.

Install

  1. Unzip maia-astro-v1.0.0.zip and move the maia-astro folder wherever you keep your projects.
  2. Open a terminal in that folder (in VS Code: Terminal → New Terminal) and install everything Maia needs:
npm install

Preview your site

npm run dev

Open http://localhost:4321 in your browser. Keep it open while you edit: the page updates every time you save a file.

Make it yours

  1. Your details. Open src/site.config.ts and change your name, credential, email, location and social links. See Site settings.
  2. Your color. Change accent in the same file.
  3. Your services. Edit the program files in src/content/programs/. See Programs.
  4. Your story and photos. Edit the About text in site.config.ts and replace the illustrations with your photos. See Colors, fonts and images.
  5. Your forms. Connect the contact and free-guide forms to a form service. See Forms and booking.
  6. Your legal pages. Adapt src/pages/privacy.md and src/pages/disclaimer.md to your practice and country.
  7. Your domain. Set site in astro.config.mjs to your address, for example https://yourname.com.

Publish

npm run build

This creates a dist folder containing your finished website. Deploying shows how to put it online for free.

Commands

Command What it does
npm install Installs what Maia needs. Run it once, and again after updating.
npm run dev Starts the live preview at localhost:4321.
npm run build Builds the finished site into dist/.
npm run preview Serves the built site so you can check it before publishing.
npm run check Checks your content and code for mistakes.