Skip to content

Commit

Permalink
Updated README and screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristineTham committed May 26, 2023
1 parent 064fbc5 commit c4d80d0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:
Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c4d80d0

Please sign in to comment.