0.0.11 ā€¢ Published 1 year ago

astro-demo v0.0.11

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

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:

CommandAction
npm installInstalls dependencies
npm run devStarts local dev server at localhost:3000
npm run buildBuild your production site to ./dist/
npm run previewPreview your build locally, before deploying
npm run astro ...Run CLI commands like astro add, astro check
npm run astro --helpGet 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.