https://github.com/kevinmichaelchen/astrojs-site
https://github.com/kevinmichaelchen/astrojs-site
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kevinmichaelchen/astrojs-site
- Owner: kevinmichaelchen
- Created: 2022-09-04T04:11:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-02T20:54:49.000Z (over 2 years ago)
- Last Synced: 2025-02-23T22:43:39.019Z (3 months ago)
- Language: Astro
- Homepage: https://kchen.io
- Size: 11.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Personal Site
Scaffolded with [AstroJS](https://astro.build/) and their [blog starter kit](https://github.com/withastro/astro/tree/main/examples/blog).
Built on [TailwindCSS](https://tailwindcss.com/). Inspired by [@antfu](https://antfu.me/).
Still a WIP.
Features:
- ✅ Minimal styling (make it your own!)
- ✅ 100/100 Lighthouse performance
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
├── public/
├── src/
│ ├── components/
│ ├── layouts/
│ └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 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 |
## Credit
This theme is based off of [Anthony Fu's](https://antfu.me/) website.