Is a free and open-source starter-kit to make your website using Astro. Ready to start a new project and designed taking into account best practices.
- Tailwind CSS (@astrojs/tailwind).
- SEO friendly (@astrojs/rss).
- Image optimization (@astrojs/images).
- Open Graph tags for social media sharing
- Fonts optimization at build time (subfont).
Table of Contents
Inside LAN.DA template, you'll see the following folders and files:
/
โโโ data/
โโโ public/
โ โโโ favicon.ico
โโโ src/
โ โโโ assets/
โ โ โโโ images/
| | โโโ styles/
| | โโโ base.css
โ โโโ components/
โ โ โโโ core/
| | โโโ general/
| | โโโ Welcome.astro
โ โโโ layouts/
โ | |โโ BaseLayout.astro
โ | |โโ PageLayout.astro
โ | โโโ ...
โ โโโ pages/
โ | โโโ index.astro
| | โโโ 404.astro
โ โโโ utils/
โ โโโ config.mjs
โโโ package.json
โโโ ...
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 if they do not require any transformation or in the assets/
directory if they are imported directly.
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:3000 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
Basic configuration file: ./src/config.mjs
export const SITE = {
name: "Example",
origin: "https://example.com",
basePathname: "/", // Change this if you need to deploy to Github Pages
title: "Example title",
description: "Example description",
};
You can create an optimized production build with:
npm run build
Now, your website is ready to be deployed. All generated files are located at
dist
folder, which you can deploy the folder to any hosting service you
prefer.
If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. That would be very useful for all of us and we would be happy to listen and take action.
MIT