Skip to content

Commit 8cf25c8

Browse files
authored
chore(deps): update vitepress (#14)
- update vitepress - switch to pnpm - fix the colors - fix markdown of other good practices
1 parent cc1cd54 commit 8cf25c8

File tree

7 files changed

+1585
-657
lines changed

7 files changed

+1585
-657
lines changed

.github/workflows/deploy.yml

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,47 @@
1-
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2-
#
3-
name: Deploy VitePress site to Pages
1+
name: Deploy to Github Pages
42

53
on:
6-
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7-
# using the `master` branch as the default branch.
84
push:
95
branches: [main]
106

11-
# Allows you to run this workflow manually from the Actions tab
127
workflow_dispatch:
138

14-
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
159
permissions:
1610
contents: read
1711
pages: write
1812
id-token: write
1913

20-
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21-
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
2214
concurrency:
2315
group: pages
2416
cancel-in-progress: false
2517

2618
jobs:
27-
# Build job
2819
build:
2920
runs-on: ubuntu-latest
3021
steps:
3122
- name: Checkout
32-
uses: actions/checkout@v3
23+
uses: actions/checkout@v4
3324
with:
34-
fetch-depth: 0 # Not needed if lastUpdated is not enabled
35-
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
25+
fetch-depth: 0
26+
- uses: pnpm/action-setup@v3
27+
with:
28+
version: 9
3629
- name: Setup Node
37-
uses: actions/setup-node@v3
30+
uses: actions/setup-node@v4
3831
with:
39-
node-version: 18
40-
cache: yarn # or pnpm / npm
32+
node-version: 20
33+
cache: pnpm
4134
- name: Setup Pages
42-
uses: actions/configure-pages@v3
35+
uses: actions/configure-pages@v4
4336
- name: Install dependencies
44-
run: yarn install # or pnpm install / npm ci
37+
run: pnpm install
4538
- name: Build with VitePress
46-
run: yarn docs:build # or pnpm docs:build / npm run docs:build
39+
run: pnpm docs:build
4740
- name: Upload artifact
48-
uses: actions/upload-pages-artifact@v2
41+
uses: actions/upload-pages-artifact@v3
4942
with:
5043
path: docs/.vitepress/dist
5144

52-
# Deployment job
5345
deploy:
5446
environment:
5547
name: github-pages
@@ -60,4 +52,4 @@ jobs:
6052
steps:
6153
- name: Deploy to GitHub Pages
6254
id: deployment
63-
uses: actions/deploy-pages@v2
55+
uses: actions/deploy-pages@v4

docs/.vitepress/config.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
import { defineConfig } from 'vitepress'
2-
3-
// https://vitepress.dev/reference/site-config
4-
export default defineConfig({
1+
export default {
52
title: "Laravel Coding Guidelines",
63
description: "Laravel Coding Guidelines",
74
base: '/laravel-coding-guidelines/',
85
head: [['link', { rel: 'icon', href: '/logo.png' }]],
96
themeConfig: {
10-
// https://vitepress.dev/reference/default-theme-config
117
siteTitle: 'Laravel Coding Guidelines',
128

139
logo: '/logo.png',
@@ -53,4 +49,4 @@ export default defineConfig({
5349
{ icon: 'github', link: 'https://github.com/xqsit94/laravel-coding-guidelines' }
5450
]
5551
}
56-
})
52+
}

docs/.vitepress/theme/custom.css

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,12 @@
66
--vp-button-brand-hover-border: #ef533f;
77
--vp-button-brand-active-bg: #ff381e;
88
--vp-button-brand-active-border: #ff7b6a;
9+
--vp-button-brand-bg: #ef533f;
10+
--vp-home-hero-name-color: #ef533f;
11+
--vp-c-brand-1: #ef533f;
12+
--vp-code-color: #24292f;
913
}
14+
15+
.dark {
16+
--vp-code-color: #c7dcee;
17+
}

docs/other-good-practices.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: default
3-
title: Other good practices
4-
nav_order: 16
5-
---
6-
71
# Other good practices
82

93
Never put any logic in routes files.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
"docs:preview": "vitepress preview docs"
66
},
77
"devDependencies": {
8-
"vitepress": "^1.0.0-beta.7"
8+
"vitepress": "^1.5.0"
99
}
1010
}

0 commit comments

Comments
 (0)