michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

edit: update README

Browse source
This commit is contained in:
bholmesdev 2022-10-24 11:45:03 -04:00
parent 87e50921ad
commit 3d784f85c4
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
examples/with-content/README.md
View file

@ -1,26 +1,30 @@
# Astro Starter Kit: Minimal # Astro Starter Kit: Content
```
npm create astro@latest -- --template minimal
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
This project is based on **[the Content Schema RFC](https://www.notion.so/astroinc/Content-Schemas-35f1952fb0a24b30b681b0509ac4d7c2)**. We suggest reading the intro and "detailed usage" sections to understand how content works.
## 🚀 Project Structure ## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files: Inside of your Astro project, you'll see the following folders and files:
``` ```sh
/ /
├── .astro/ # Generated on build
├── public/ ├── public/
├── src/ ├── src/
│ └── content/
│ └── blog/
│ ├── ~schema.ts
│ ├── first.md
│ └── second.md
│ └── pages/ │ └── pages/
│ └── index.astro │ └── index.astro
└── package.json └── package.json
``` ```
`src/content/` contains "collections" of Markdown or MDX documents you'll use in your website. Astro will generate a `fetchContent` function to grab posts from `src/content/` (see the generated `.astro` directory), with type-checked frontmatter based on a schema.
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. 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. There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.