Skip to content

Commit

Permalink
commit: 03-12-2024
Browse files Browse the repository at this point in the history
  • Loading branch information
gambhirsharma committed Dec 3, 2024
1 parent 5e8dd15 commit 32c297d
Show file tree
Hide file tree
Showing 34 changed files with 7,355 additions and 359 deletions.
110 changes: 7 additions & 103 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,9 @@
# Vitesse theme for Astro
# gambhir.xyz
Personal website

A minimal, SEO-friendly portfolio and blog theme for Astro, supports Vue and UnoCSS.
## Screenshots

[![Netlify Status](https://api.netlify.com/api/v1/badges/0624323a-339f-48da-8b28-03037d664c40/deploy-status)](https://app.netlify.com/sites/astro-theme-vitesse/deploys)

## Preview

![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)

## Quick Start

[![Deploy to Netlify Button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/kevinwong865/astro-theme-vitesse)

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.

If you just want to develop locally, you can [create a repo](https://github.com/kevinwong865/astro-theme-vitesse/generate) from this template on GitHub.

## Usage

Just run and visit http://localhost:1977.

```bash
npn run dev
```

> Node.js version 18 or higher is required for this project.
To build the App, you can run:

```bash
npm run build
```

You will then see the `dist` folder generated for publishing, which you can preview locally with the following command.

```bash
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"
}
}
```

## License

[MIT License](./LICENSE) © 2024 [Kieran Wang](https://github.com/kieranwv/)
---
## Inspiration:
- [Template](https://github.com/kieranwv/astro-theme-vitesse)
- [nexxle.dev](https://www.nexxel.dev/)
2 changes: 1 addition & 1 deletion astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import UnoCSS from 'unocss/astro'
import vue from '@astrojs/vue'

export default defineConfig({
site: 'https://astro-theme-vitesse.netlify.app/',
site: 'https://astro-theme-vitesse.ntlify.app/',
server: {
port: 1977,
},
Expand Down
18 changes: 8 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
{
"name": "astro-theme-vitesse",
"name": "gambhir.xyz",
"type": "module",
"version": "1.1.0",
"description": "A minimal, SEO-friendly portfolio and blog theme for Astro, supports Vue and UnoCSS.",
"author": "Kieran Wong <kieranwong9865@gmail.com> (https://github.com/kieranwong9865/)",
"description": "Gambhir Shamra Personal website",
"author": "Gambhir Sharma <gambhir786191ss@gmail.com> (https://github.com/gambhirsharma/)",
"license": "MIT",
"keywords": [
"kieranwong9865",
"astro-theme-vitesse",
"astro",
"blog",
"starter",
"template"
"gambhir",
"personal"
],
"engines": {
"node": ">=v18.17.1 || >=v20.3.0 || >=21"
Expand Down Expand Up @@ -44,17 +42,17 @@
"@vueuse/core": "^10.11.0",
"bumpp": "^9.4.1",
"eslint": "^8.57.0",
"eslint-plugin-astro": "^0.31.4",
"eslint-plugin-astro": "^1.3.1",
"eslint-plugin-format": "^0.1.2",
"lint-staged": "^15.2.7",
"lodash-es": "^4.17.21",
"prettier-plugin-astro": "^0.13.0",
"simple-git-hooks": "^2.11.1"
},
"simple-git-hooks": {
"pre-commit": "npx lint-staged"
"pre-commit": "pnpm lint-staged"
},
"lint-staged": {
"*": "npm run lint:fix"
"*": "pnpm run lint:fix"
}
}
Loading

0 comments on commit 32c297d

Please sign in to comment.