generated from kieranwv/astro-theme-vitesse
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5e8dd15
Showing
62 changed files
with
14,941 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
github: kaivanwong |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: CI | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Set node | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: lts/* | ||
|
||
- name: Install dependencies | ||
run: npm install | ||
|
||
- name: Lint | ||
run: npm run lint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Release | ||
|
||
on: | ||
push: | ||
tags: | ||
- 'v*' | ||
|
||
jobs: | ||
release: | ||
permissions: | ||
contents: write | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- uses: actions/setup-node@v3 | ||
with: | ||
node-version: lts/* | ||
|
||
- run: npx changelogen gh release | ||
env: | ||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
dist | ||
node_modules | ||
.astro | ||
.DS_Store | ||
.eslintcache | ||
*.log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"recommendations": [ | ||
"astro-build.astro-vscode", | ||
"dbaeumer.vscode-eslint", | ||
"usernamehw.errorlens", | ||
"vue.vscode-typescript-vue-plugin", | ||
"vue.volar", | ||
"antfu.unocss", | ||
"antfu.iconify" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
{ | ||
// Enable the ESlint flat config support | ||
"eslint.experimental.useFlatConfig": true, | ||
// Disable the default formatter, use eslint instead | ||
"prettier.enable": false, | ||
"editor.formatOnSave": false, | ||
// Auto fix | ||
"editor.codeActionsOnSave": { | ||
"source.fixAll.eslint": "explicit", | ||
"source.organizeImports": "never" | ||
}, | ||
// Silent the stylistic rules in you IDE, but still auto fix them | ||
"eslint.rules.customizations": [ | ||
{ | ||
"rule": "style/*", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "format/*", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*-indent", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*-spacing", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*-spaces", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*-order", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*-dangle", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*-newline", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*quotes", | ||
"severity": "off" | ||
}, | ||
{ | ||
"rule": "*semi", | ||
"severity": "off" | ||
} | ||
], | ||
// Enable eslint for all supported languages | ||
"eslint.validate": [ | ||
"javascript", | ||
"javascriptreact", | ||
"typescript", | ||
"typescriptreact", | ||
"vue", | ||
"html", | ||
"markdown", | ||
"json", | ||
"jsonc", | ||
"yaml", | ||
"toml", | ||
"astro" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Kieran Wang | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# Vitesse theme for Astro | ||
|
||
A minimal, SEO-friendly portfolio and blog theme for Astro, supports Vue and UnoCSS. | ||
|
||
[![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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
import { defineConfig } from 'astro/config' | ||
import mdx from '@astrojs/mdx' | ||
import sitemap from '@astrojs/sitemap' | ||
import UnoCSS from 'unocss/astro' | ||
import vue from '@astrojs/vue' | ||
|
||
export default defineConfig({ | ||
site: 'https://astro-theme-vitesse.netlify.app/', | ||
server: { | ||
port: 1977, | ||
}, | ||
integrations: [ | ||
mdx(), | ||
sitemap(), | ||
UnoCSS({ | ||
injectReset: true, | ||
}), | ||
vue(), | ||
], | ||
markdown: { | ||
shikiConfig: { | ||
themes: { | ||
light: 'github-light-default', | ||
dark: 'github-dark-default', | ||
}, | ||
wrap: true, | ||
}, | ||
}, | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import antfu from '@antfu/eslint-config' | ||
|
||
export default antfu({ | ||
vue: true, | ||
typescript: true, | ||
astro: true, | ||
formatters: { | ||
astro: true, | ||
css: true, | ||
}, | ||
}) |
Oops, something went wrong.