Skip to content
View jonkurtis's full-sized avatar
Block or Report

Block or report jonkurtis

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Please don't include any personal information such as legal names or email addresses. Maximum 100 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
jonkurtis/README.md

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

Popular repositories

  1. keystone keystone Public

    Forked from keystonejs/keystone-classic

    node.js cms and web app framework

    JavaScript

  2. fmm-understrap fmm-understrap Public

    Forked from understrap/understrap

    πŸ‘« Combines AutomatticΒ΄s Underscores Starter Theme and Bootstrap 4 - Visit:

    CSS

  3. react_express_starter react_express_starter Public

    Forked from bradtraversy/react_express_starter

    Starter pack for React and Express full stack development

    JavaScript

  4. atlas-vue atlas-vue Public

    Vue

  5. gnutolinux gnutolinux Public

    JavaScript

  6. gatsby gatsby Public

    Forked from gatsbyjs/gatsby

    Build blazing fast, modern apps and websites with React

    JavaScript