Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 14 additions & 22 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,55 +1,47 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages
name: Deploy to Github Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

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

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
fetch-depth: 0
- uses: pnpm/action-setup@v3
with:
version: 9
- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn # or pnpm / npm
node-version: 20
cache: pnpm
- name: Setup Pages
uses: actions/configure-pages@v3
uses: actions/configure-pages@v4
- name: Install dependencies
run: yarn install # or pnpm install / npm ci
run: pnpm install
- name: Build with VitePress
run: yarn docs:build # or pnpm docs:build / npm run docs:build
run: pnpm docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
Expand All @@ -60,4 +52,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
8 changes: 2 additions & 6 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
export default {
title: "Laravel Coding Guidelines",
description: "Laravel Coding Guidelines",
base: '/laravel-coding-guidelines/',
head: [['link', { rel: 'icon', href: '/logo.png' }]],
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
siteTitle: 'Laravel Coding Guidelines',

logo: '/logo.png',
Expand Down Expand Up @@ -53,4 +49,4 @@ export default defineConfig({
{ icon: 'github', link: 'https://github.com/xqsit94/laravel-coding-guidelines' }
]
}
})
}
8 changes: 8 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,12 @@
--vp-button-brand-hover-border: #ef533f;
--vp-button-brand-active-bg: #ff381e;
--vp-button-brand-active-border: #ff7b6a;
--vp-button-brand-bg: #ef533f;
--vp-home-hero-name-color: #ef533f;
--vp-c-brand-1: #ef533f;
--vp-code-color: #24292f;
}

.dark {
--vp-code-color: #c7dcee;
}
6 changes: 0 additions & 6 deletions docs/other-good-practices.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: default
title: Other good practices
nav_order: 16
---

# Other good practices

Never put any logic in routes files.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
"docs:preview": "vitepress preview docs"
},
"devDependencies": {
"vitepress": "^1.0.0-beta.7"
"vitepress": "^1.5.0"
}
}
Loading