History

Obinna Ekwuno db2c59fc18 Update open with codesandbox link to use synced sandboxes (#6105 )		2023-02-03 11:52:11 -06:00
..
.vscode	[ci] format	2022-03-22 03:16:42 +00:00
public	Switch examples favicon to use svg (#4331 )	2022-08-17 15:19:04 -05:00
src	[RSS] Get ready for content collections (#5851 )	2023-01-19 11:24:55 -05:00
.gitignore	Add `.astro/` to `.gitignore` in example projects (#5841 )	2023-01-12 11:26:13 -05:00
astro.config.mjs	[ci] format	2022-08-15 04:28:38 +00:00
package.json	[ci] release (#6094 )	2023-02-02 15:38:04 -05:00
README.md	Update open with codesandbox link to use synced sandboxes (#6105 )	2023-02-03 11:52:11 -06:00
sandbox.config.json	Adding CodeSandbox config file to all the "next" examples (#1744 )	2021-11-05 10:41:37 -05:00
tsconfig.json	Add template tsconfigs for users to extend from (#4439 )	2022-08-25 15:15:27 -04:00

README.md

Astro Starter Kit: Blog

npm create astro@latest -- --template blog

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

Features:

✅ Minimal styling (make it your own!)
✅ 100/100 Lighthouse performance
✅ SEO-friendly with canonical URLs and OpenGraph data
✅ Sitemap support
✅ RSS Feed support
✅ Markdown & MDX support

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

├── public/
├── src/
│   ├── components/
│   ├── content/
│   ├── layouts/
│   └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json

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.

The src/content/ directory contains "collections" of related Markdown and MDX documents. Use getCollection() to retrieve posts from src/content/blog/, and type-check your frontmatter using an optional schema. See Astro's Content Collections docs to learn more.

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:

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.