https://github.com/lokimckay/astro-starter

My lightweight Astro starter template
https://github.com/lokimckay/astro-starter

Last synced: 23 days ago
JSON representation

My lightweight Astro starter template

• Host: GitHub
• URL: https://github.com/lokimckay/astro-starter
• Owner: lokimckay
• Created: 2024-08-04T05:03:20.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-04T07:24:28.000Z (3 months ago)
• Last Synced: 2024-10-04T10:36:22.289Z (about 1 month ago)
• Language: Astro
• Homepage: https://lokimckay.github.io/astro-starter/
• Size: 545 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Astro Starter

My lightweight Astro starter template

Demo: https://lokimckay.github.io/astro-starter/

## Features

- [Dark/light mode toggle](https://docs.astro.build/en/tutorial/6-islands/2/)

- [Emoji favicon](https://css-tricks.com/emoji-as-a-favicon/)

- [Fixel font](https://fixel.macpaw.com/)

- [View transitions](https://docs.astro.build/en/guides/view-transitions/)

- [MDX integration](https://docs.astro.build/en/guides/integrations-guide/mdx/)

- TS config `"@/*": ["./src/*"]` path mapping

- Github pages deployment

## Usage

```shell

npx degit lokimckay/astro-starter my-new-project \

cd my-new-project \

npm install \

npm start

```

## Optional next steps

### Add integrations

- [preact](https://docs.astro.build/en/guides/integrations-guide/preact)

### Remove github pages deployment

1. Delete `.github` directory

1. Remove `site` and `base` configuration from `astro.config.mjs`

1. Change relative navigation links (e.g. `"./about"`) to absolute in `layouts/base.astro`

1. Change relative asset links (e.g. `"./fonts/*`) to absolute in `styles/base.css`