53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
|
# Astro Content Collections (Experimental)
|
||
|
|
|
||
|
|
This demos our Blog Starter using **[the experimental Content Collections API.](https://docs.astro.build/en/guides/content-collections)**
|
||
|
|
|
||
|
|
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-content)
|
||
|
|
[](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/with-content)
|
||
|
|
|
||
|
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||
|
|
|
||
|
|
## 🚀 Project Structure
|
||
|
|
|
||
|
|
Inside of your Astro project, you'll see the following folders and files:
|
||
|
|
|
||
|
|
```
|
||
|
|
├── public/
|
||
|
|
├── src/
|
||
|
|
│ └── content/
|
||
|
|
│ └── blog/
|
||
|
|
│ ├── first.md
|
||
|
|
│ └── second.md
|
||
|
|
│ └── config.ts
|
||
|
|
│ ├── components/
|
||
|
|
│ ├── layouts/
|
||
|
|
│ └── pages/
|
||
|
|
├── astro.config.mjs
|
||
|
|
├── README.md
|
||
|
|
├── package.json
|
||
|
|
└── tsconfig.json
|
||
|
|
```
|
||
|
|
|
||
|
|
`src/content/` contains "collections" of related Markdown and MDX documents. Astro will generate a `getCollection` function to retrieve posts from `src/content/`, and type-check your frontmatter using an optional schema (see `src/content/config.ts`).
|
||
|
|
|
||
|
|
## 🧞 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:3000` |
|
||
|
|
| `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?
|
||
|
|
|
||
|
|
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|
||
|
|
|
||
|
|
## Credit
|
||
|
|
|
||
|
|
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
|