Git Product home page Git Product logo

astro-template's Introduction

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

astro-template's People

Contributors

joneiros avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.