Welcome to Atlas!

1. To get started, first install all necessary packages with npm install or pnpm install, then run an initial build to make sure the setup works npm run build or pnpm build.
2. Next, you'll want to configure your site i18n setup (one language, or multiple). Simply run the command npm run config-i18n and follow the script instructions to get setup! For further information, see the i18n documentation.
3. Now you can setup the site to your liking!
   • Style customization
   • Content editing
   • Animations
   • Keystatic CMS - if you don't want Keystatic you can run npm run remove-keystatic
   • Forms

Should you need any assistance, send me a message at support@cosmicthemes.com

Code Intro

I have created a few code tours to help introduce you to the codebase. You will need the extension Code Tour to view them in VSCode.

Code Structure

The source files have the following setup. Note that not all files are included - it is already long, no one wants it to be longer.

.
├── .tours/
│   └── code-intro.tour
├── public/
│   ├── favicons/
│   │   └── favicon.ico
│   ├── images/
│   └── robots.txt
├── src/
│   ├── assets/
│   │   └── images/
│   │       └── hero.jpg
│   ├── components/
│   │   ├── Hero/
│   │   │   ├── HeroBgImage.astro
│   │   │   ├── HeroCentered.astro
│   │   │   └── HeroSideImage.astro
│   │   └── Footer/
│   │       └── Footer.astro
│   ├── config/
│   │   ├── siteSettings.json.ts
│   │   └── translationData.json.ts
│   ├── content/
│   │   ├── authors/
│   │   ├── blog/
│   │   ├── otherPages/
│   │   └── config.ts
│   ├── js/
│   │   └── blogUtils.ts
│   ├── layouts/
│   │   └── BaseLayout.astro
│   ├── pages/
│   │   ├── index.astro
│   │   ├── blog/
│   │   │   ├── [...slug].astro
│   │   │   └── index.astro
│   │   ├── categories/
│   │   │   ├── [category].astro
│   │   │   └── index.astro
│   │   ├── examples/
│   │   │   └── (contains example pages so you can see how to use components)
│   │   ├── [page].astro
│   │   ├── 404.astro
│   │   ├── contact.astro
│   │   ├── index.astro
│   │   └── rss.xml.ts
│   └── styles/
│       └── global.css
├── .gitignore
├── .prettierrc.mjs
├── astro.config.mjs
├── netlify.toml
├── package.json
├── README.md
└── tsconfig.json

For robots like Google to see the correct sitemap, you will want to edit the public/robots.txt file to use your website domain.

More Resources

• See my blog post on recommended Astro web development setup.
• You can learn more information from the theme docs page on the Cosmic Themes Website.
• For support, see the support page.
• License details

General Astro Info

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory. I also frequently use src/assets for images when using Astro asssets for image optimization.

Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:4321
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI

Want to learn more?

Feel free to check the documentation or jump into the Discord server.