Skip to content

kydecker/astro-starter

Repository files navigation

Ky's Astro Starter

An Astro starter project set up with pnpm, Biome, simple-git-hooks, and Astro Sitemap, plus sensible VS Code defaults and recommended workspace extensions.

Getting Started

  1. Click "Use this template" and create a new repository.
  2. In astro.config.mjs, update site from https://mysite.com to your site URL.
  3. In src/layouts/BaseLayout.astro, update siteName to your site name.
  4. Good to go!

What's included

Basics

  • A blank Astro project with TypeScript enabled
  • pnpm package management plus only-allow pnpm
  • Import aliases of src using ~ to enable using import { Component } from '~/components'
  • Basic meta tags and open graph tags in layouts/BaseLayout.astro
  • initial-scale=1 on viewport to prevent default mobile zoom-out
  • Site name displays after the page title (Page Title · Site Name) on pages other than the main index
  • smartypants smart quotes for page titles and descriptions

Styles

Linting and Formatting

  • Linting and formatting with Biome

VS Code

Package.json scripts

  • check — Run Astro check + Biome lint and format
  • check:fix — Run Astro check + Biome lint and format + fix errors

Pre-commit checks with simple-git-hooks and nano-staged

  • biome check --write on pre-commit

Dependabot

  • Weekly dependency update checks
  • All GitHub Action updates grouped in a single pull request
  • All patch or minor package updates grouped in a single pull request
  • All major package updates created as individual pull requests

Config

  • Link prefetching enabled
  • Dev toolbar disabled
  • Astro Sitemap installed

About

Blank Astro project with Biome 2, Stylelint, reset.css, and more

Topics

Resources

Stars

Watchers

Forks

Contributors