0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/examples/blog
Houston (Bot) fcdd37f684
[ci] release (#12567)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-12-03 10:56:34 +00:00
..
.codesandbox
.vscode Recommend the VSCode MDX extension in blog example (#8913) 2023-10-30 12:22:38 +01:00
public nit: optimize images (#8629) 2023-09-22 12:04:39 +02:00
src Update examples for v5 (#12588) 2024-12-03 11:00:43 +01:00
.gitignore Add .idea folder to .gitignore files of the examples (#10602) 2024-04-03 09:03:44 +01:00
astro.config.mjs create-astro updates (#12083) 2024-11-04 16:15:11 +01:00
package.json [ci] release (#12567) 2024-12-03 10:56:34 +00:00
README.md Fix: lang unspecified code blocks (#8461) 2023-09-11 12:45:21 +01:00
tsconfig.json create-astro updates (#12083) 2024-11-04 16:15:11 +01:00

Astro Starter Kit: Blog

npm create astro@latest -- --template blog

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

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

blog

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:4321
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.