Skip to content

README.md

Latest commit

 

History

History
139 lines (107 loc) · 6.93 KB

README.md

File metadata and controls

139 lines (107 loc) · 6.93 KB
Raw

willtheorangeguy.github.io

My personal site: an Astro + AstroPaper + Tailwind blog and portfolio, deployed to GitHub Pages.

Astro Build State Docker State CodeQL State Gitleaks State GitHub Version GitHub Issues GitHub Pull Requests License

Key Features • Installation • Usage • Documentation • Support • Contributing • Credits • License

screenshot

The live site is at williamvdg.me.

Key Features

  • A static Astro 7 blog on the AstroPaper theme, styled with Tailwind 4.
  • Posts are Markdown with a Zod-validated schema, so a typo in frontmatter fails the build rather than publishing quietly.
  • Per-post social preview images generated at build time with Satori.
  • Client-side search over the whole site via Pagefind — no search backend.
  • Projects, Labs, and Uses pages, plus a published Storybook style guide at /styleguide.
  • Short-link redirects under /r/, and Google Maps contribution stats refreshed on a schedule.
  • Deployed to GitHub Pages and mirrored as a Docker image on every push to main.

Installation

git clone https://github.com/willtheorangeguy/willtheorangeguy.github.io.git
cd willtheorangeguy.github.io
npm install
npm run dev

Then open http://localhost:4321 — http, not https. Either npm or pnpm works locally; CI uses pnpm. Docker and production builds are covered in docs/installation.md.

Usage

Posts are Markdown files in src/data/blog/:

---
title: A title
pubDatetime: 2026-08-19T10:00:00Z
description: One sentence, used for previews and the generated OG image.
---

Body copy.

title, pubDatetime, and description are required; tags, draft, featured, and the rest are optional and documented in docs/usage.md.

Search is powered by Pagefind, which indexes built output — it works after npm run build && npm run preview, not under npm run dev.

Documentation

Full documentation lives in docs/: Installation · Quickstart · Usage · Configuration · Architecture · Development · Deployment · Google Maps automation · FAQ · Troubleshooting · Roadmap

Legal text served by the site lives in docs/legal/: Privacy Policy and Terms and Conditions.

Visualization of the codebase

Support

Open a GitHub Discussion or file an issue.

Contributing

Contributions welcome. See the org-wide Contributing Guide and Code of Conduct.

Credits

This software uses the following open source packages, projects, services or websites:

Astro Astro Paper Tailwind CSS W3C Simple Analytics
Astro AstroPaper Tailwind CSS W3C Simple Analytics
Web GitHub Web - GitHub Web - Donate Web - Plans

Contributors

License

This project is licensed under the MIT License - see the LICENSE file for details. See the Privacy Policy and Terms and Conditions for legal information.