ericmasiello / synbydesign

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Astro Starter Kit: Blog

npm init astro -- --template blog

Open in StackBlitz

πŸ§‘β€πŸš€ 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/
β”‚   β”œβ”€β”€ 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.

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.


Secrets

This site is hosted on Netlify. Use the netlify-cli to set secrets.

npx netlify-cli env:set SECRET_PHONE '123-456-7890'

About

License:MIT License


Languages

Language:Astro 64.6%Language:CSS 15.7%Language:TypeScript 11.1%Language:JavaScript 6.1%Language:MDX 2.4%