zaduma

astro template

Stars
63

zaduma

an Astro starter template for understated personal websites

Built with:

🏎️ Usage TLDR

  1. Click Use this template to create a new repo.
  2. Set VERCEL_TOKEN, VERCEL_PROJECT_ID, and VERCEL_ORG_ID secrets to
    deploy to Vercel from GHA (enables access to git history).
  3. Add OG_IMAGE_SECRET to secure your OG image endpoint.

See full usage instructions.

🏛 Project Structure

Inside of your Astro project, you'll see the following folders and files:

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
pnpm install Installs dependencies
pnpm run dev Starts local dev server at localhost:3000
pnpm run build Build your production site to ./dist/
pnpm run preview Preview your build locally, before deploying
pnpm run astro ... Run CLI commands like astro add, astro check
pnpm run astro --help Get help using the Astro CLI

👌 Usage

  1. Click Use this template to create a new repo.

  2. Clone the repository, install with pnpm install and run with pnpm dev.

  3. Style it and personalize however you like 💅

  4. Set VERCEL_TOKEN, VERCEL_PROJECT_ID, and VERCEL_ORG_ID secrets to deploy to Vercel from GHA (what enables access to git history). (Settings→Secrets)

    • Alternatively — if all your blog posts have a date in frontmatter, you
      don't need to deploy through workflows/ci.yml. Feel free to remove the
      deploy steps from the YML file and connect Vercel/Netlify integration. Go
      to derivedTitleAndDatePlugin function and remove execSync("git log")
      from it. (TODO: Can we make it more convenient?)
  5. Generate a passphrase for OG_IMAGE_SECRET to secure your OG image endpoint, and add it to Actions Secrets.