2024-03-13 05:56:42 +00:00
# Vitesse theme for Astro
2024-02-29 01:58:28 +00:00
2024-05-13 05:53:24 +00:00
Vitesse theme for Astro, a minimal, SEO-friendly portfolio and blog theme, supports Vue and UnoCSS.
2024-03-13 07:17:11 +00:00
[![Netlify Status ](https://api.netlify.com/api/v1/badges/d5bae292-6116-4c52-af4b-05eadedccc60/deploy-status )](https://app.netlify.com/sites/kaivanwong/deploys)
## Preview
2024-05-13 05:53:24 +00:00
![Preview Image ](./public/preview.jpg )
## Features
- 100 / 100 Lighthouse performance
- Responsive
- SEO-friendly
- Light / Dark Theme
- Markdown support
- < a target = "_blank" href = "https://mdxjs.com/" > MDX</ a > (components in your markdown) support
- < a target = "_blank" href = "https://vuejs.org/" > Vue</ a > SFC component support
- Auto generated sitemap and RSS Feed< a target = "_blank" href = "https://vueuse.org/" > VueUse</ a > & < a target = "_blank" href = "https://lodash.com/" > Lodash</ a > support
- Use the < a target = "_blank" href = "https://unocss.dev/" > Unocss</ a > for style, it's fast.
## Lighthouse Performance
![Lighthouse Performance Image ](./public/lighthouse.jpg )
2024-03-13 07:17:11 +00:00
## Quick Start
[![Deploy to Netlify Button ](https://www.netlify.com/img/deploy/button.svg )](https://app.netlify.com/start/deploy?repository=https://github.com/kaivanwong/astro-theme-vitesse)
2024-03-13 08:04:52 +00:00
Click this button, it will create a new repo for you that looks exactly like this one, and sets that repo up immediately for deployment on Netlify.
2024-03-18 05:43:21 +00:00
If you just want to develop locally, you can [create a repo ](https://github.com/kaivanwong/astro-theme-vitesse/generate ) from this template on GitHub.
2024-03-13 07:17:11 +00:00
## Usage
Just run and visit http://localhost:1977.
```bash
2024-05-06 02:59:07 +00:00
npn run dev
2024-03-13 07:17:11 +00:00
```
2024-05-06 02:59:07 +00:00
> Node.js version 18 or higher is required for this project.
2024-03-13 07:17:11 +00:00
To build the App, you can run:
```bash
2024-05-06 02:59:07 +00:00
npm run build
2024-03-13 07:17:11 +00:00
```
You will then see the `dist` folder generated for publishing, which you can preview locally with the following command.
```bash
2024-05-06 02:59:07 +00:00
npm run preview
```
## Use pnpm / yarn
If you want to use pnpm or yarn as a package management tool, please refer to the following steps.
> If `preinstall` exists in `scripts`, remove it first.
### pnpm
Replace `"pre-commit": "npx lint-staged"` in package.json with `"pre-commit": "pnpm lint-staged"` .
And replace `"*": "npm run lint:fix"` with `"*": "pnpm lint:fix"` .
Like this:
```json
{
// ...
"simple-git-hooks": {
"pre-commit": "pnpm lint-staged"
},
"lint-staged": {
"*": "pnpm lint:fix"
}
}
```
### yarn
Replace `"pre-commit": "npx lint-staged"` in package.json with `"pre-commit": "yarn lint-staged"` .
And replace `"*": "npm run lint:fix"` with `"*": "yarn lint:fix"` .
Like this:
```json
{
// ...
"simple-git-hooks": {
"pre-commit": "yarn lint-staged"
},
"lint-staged": {
"*": "yarn lint:fix"
}
}
2024-03-13 07:17:11 +00:00
```
## License
[MIT License ](./LICENSE ) © 2024-PRESENT [Kaivan Wong ](https://github.com/kaivanwong )