0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-01-06 22:10:10 -05:00
astro/examples/with-content
Ben Holmes c2180746b4
[Content collections] Move generated types to .astro directory (#5786)
* feat: change cacheDir to `.astro`

* feat: write reference in env.d.ts if none exists

* chore: update with-content types

* test: env.d.ts transform

* nit: setUp -> add

* refactor: content.d.ts -> types.d.ts

* chore: update confirmation log

* chore: changeset

* feat: inject env.d.ts if none exists

* feat: set up env.d.ts on `astro sync`

* chore: duplicate envTsPathRelative

* docs: update changeset

* fix: make srcDir if none exists

* fix: types.generated -> .astro in gitignore

* feat: add env.d.ts to test gitignore

* chore: remove env.d.ts from content-collections

* test: move sync tests to `astro sync`, add file write test

* refactor: simplify test gitignore to base

* fix: add / to `.astro` bc that scares me
2023-01-10 18:01:52 -05:00
..
.astro [Content collections] Move generated types to .astro directory (#5786) 2023-01-10 18:01:52 -05:00
.vscode Content Collections (#5291) 2022-12-16 14:19:53 -05:00
public Content Collections (#5291) 2022-12-16 14:19:53 -05:00
src [Content collections] Move generated types to .astro directory (#5786) 2023-01-10 18:01:52 -05:00
.gitignore Content Collections (#5291) 2022-12-16 14:19:53 -05:00
astro.config.mjs Content Collections (#5291) 2022-12-16 14:19:53 -05:00
package.json [ci] release (beta) (#5742) 2023-01-06 13:00:12 -05:00
README.md Fix links in content used by docs (#5631) 2022-12-18 13:00:30 +01:00
sandbox.config.json Content Collections (#5291) 2022-12-16 14:19:53 -05:00
tsconfig.json Content Collections (#5291) 2022-12-16 14:19:53 -05:00

Astro Content Collections (Experimental)

This demos our Blog Starter using the experimental Content Collections API.

Open in StackBlitz Open with CodeSandbox

🧑‍🚀 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 or jump into our Discord server.

Credit

This theme is based off of the lovely Bear Blog.