diff --git a/README.md b/README.md index 3569700..c109169 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Astro Base +[![Netlify Status](https://api.netlify.com/api/v1/badges/ab88bd2f-6bc0-4352-af4f-d7f490975684/deploy-status)](https://app.netlify.com/sites/astro-base/deploys) + +![screenshot](https://github.com/hellotham/astro-base/blob/main/src/screenshot.png?raw=true) + Minimal [Astro](https://astro.build) starter for new projects. MIT licence. Uses: @@ -17,24 +21,24 @@ Inside of your Astro project, you'll see the following folders and files: ```text / -├── public/ +├── astro.config.mjs # Astro configuration file +├── public/ # Location of static assets │ └── favicon.svg ├── src/ -│ ├── components/ -│ │ └── Card.astro -│ ├── layouts/ +│ ├── assets/ # Location of dynamic assets (eg. images) +│ │ └── screenshot.png +│ ├── components/ # Astro components +│ │ └── header.astro +│ ├── content/ # Location of content (markdown, data and images) +│ │ └── config.ts +│ ├── layouts/ # Location of layouts for pages │ │ └── Layout.astro -│ └── pages/ +│ └── pages/ # Location of pages │ └── index.astro -└── package.json +├── package.json +└── uno.config.ts # UnoCSS configuration file ``` -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. - ## 🧞 Commands All commands are run from the root of the project, from a terminal: diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..9072139 Binary files /dev/null and b/screenshot.png differ