Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 1.91 KB

README.md

File metadata and controls

44 lines (36 loc) · 1.91 KB

Astro Template

This is an Astro template for building a personal website. If you are new to Astro, I highly recommend checking out their main page before diving into this template.

You can check out a live example of this template on my personal site, at jongander.com.

Note that I have continued to develop my personal site, so it may not align with this template fully.

Setup and Run 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

Behaviours

Some of these behaviours are native to Astro, others may be reminders to myself of limitations caused by how I've built the project. They'll be loosely ordered in terms of criticality. Also check Astro Documentation.

Behaviours:

  • <title> and some meta tags may default to the Base if the page title and filename differ, as the frontmatter.title is currently being parsed to get the URL to inject into Base.astro for blog posts
  • Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
  • Any static assets, like images, can be placed in the public/ directory.

Starting Environment

For Reference, this is where I started:

  • Astro Starter Kit: Minimal