Skip to content

Commit defa75e

Browse files
RichardAndersonRichardAnderson
committed
VitePress initial commit
0 parents  commit defa75e

26 files changed

Lines changed: 6076 additions & 0 deletions

‎.github/workflows/deploy.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy VitePress site to Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Setup Node
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: 22
30+
cache: npm
31+
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v4
34+
35+
- name: Install dependencies
36+
run: npm ci
37+
38+
- name: Build with VitePress
39+
run: npm run docs:build
40+
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: docs/.vitepress/dist
45+
46+
deploy:
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
needs: build
51+
runs-on: ubuntu-latest
52+
name: Deploy
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/coverage
2+
/src/client/shared.ts
3+
/src/node/shared.ts
4+
*.log
5+
*.tgz
6+
.DS_Store
7+
.idea
8+
.temp
9+
.vite_opt_cache
10+
.vscode
11+
dist
12+
cache
13+
temp
14+
examples-temp
15+
node_modules
16+
pnpm-global
17+
TODOs.md
18+
*.timestamp-*.mjs

‎docs/.vitepress/config.mjs‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
export default defineConfig({
4+
title: 'Actionable',
5+
description: 'Clean, testable, and reusable actions for Laravel applications',
6+
7+
head: [
8+
['link', { rel: 'icon', href: '/images/LumoSolutionsLogo.png' }],
9+
['meta', { name: 'theme-color', content: '#3c82f6' }],
10+
['meta', { property: 'og:type', content: 'website' }],
11+
['meta', { property: 'og:locale', content: 'en' }],
12+
['meta', { property: 'og:title', content: 'Actionable | Laravel Actions & DTOs' }],
13+
['meta', { property: 'og:site_name', content: 'Actionable' }],
14+
['meta', { property: 'og:image', content: 'https://actionable.lumosolutions.org/images/LumoSolutionsLogo.png' }],
15+
['meta', { property: 'og:url', content: 'https://actionable.lumosolutions.org/' }],
16+
],
17+
18+
themeConfig: {
19+
logo: '/images/LumoSolutionsLogo.png',
20+
21+
nav: [
22+
{ text: 'Installation', link: '/guide/installation' },
23+
{ text: 'Getting Started', link: '/guide/getting-started' },
24+
{
25+
text: 'More',
26+
items: [
27+
//{ text: 'Examples', link: '/examples/basic-usage' },
28+
{ text: 'Best Practice', link: '/guide/best-practice' },
29+
{ text: 'Contributing', link: '/contributing' }
30+
]
31+
},
32+
{
33+
text: 'GitHub',
34+
link: 'https://github.com/LumoSolutions/actionable'
35+
}
36+
],
37+
38+
sidebar: {
39+
'/guide/': [
40+
{
41+
text: 'Getting Started',
42+
items: [
43+
{ text: 'Installation', link: '/guide/installation' },
44+
{ text: 'Quick Start', link: '/guide/getting-started' },
45+
]
46+
},
47+
{
48+
text: 'Comparisons',
49+
items: [
50+
{ text: 'Laravel Actions', link: '/guide/vs-laravel-actions' }
51+
]
52+
},
53+
{
54+
text: 'Core Concepts',
55+
items: [
56+
{ text: 'Actions', link: '/guide/actions' },
57+
{ text: 'Queues', link: '/guide/queues' },
58+
{ text: 'Data Transfer Objects', link: '/guide/dtos' },
59+
{ text: 'Attributes', link: '/guide/attributes' },
60+
{ text: 'Testing', link: '/guide/testing' }
61+
]
62+
},
63+
{
64+
text: 'Artisan Commands',
65+
items: [
66+
{ text: 'make:action', link: '/guide/make-action' },
67+
{ text: 'make:dto', link: '/guide/make-dto' },
68+
{ text: 'ide-helper:actions', link: '/guide/ide-helper' },
69+
{ text: 'Export Stubs', link: '/guide/export-stubs' }
70+
]
71+
},
72+
{
73+
text: 'Advanced Topics',
74+
items: [
75+
{ text: 'Best Practices', link: '/guide/best-practices' },
76+
{ text: 'Upgrade Guide', link: '/guide/upgrade' },
77+
{ text: 'Contributing', link: '/guide/contributing' }
78+
]
79+
}
80+
],
81+
},
82+
83+
socialLinks: [
84+
{ icon: 'github', link: 'https://github.com/LumoSolutions/actionable' }
85+
],
86+
87+
editLink: {
88+
pattern: 'https://github.com/LumoSolutions/actionable-docs/edit/main/docs/:path',
89+
text: 'Edit this page on GitHub'
90+
},
91+
92+
footer: {
93+
message: 'Released under the MIT License.',
94+
copyright: 'Copyright © 2024 Lumo Solutions'
95+
},
96+
97+
search: {
98+
provider: 'local'
99+
},
100+
101+
outline: {
102+
level: [2, 3]
103+
}
104+
},
105+
106+
markdown: {
107+
theme: {
108+
light: 'github-light',
109+
dark: 'github-dark'
110+
},
111+
lineNumbers: true
112+
},
113+
114+
lastUpdated: true,
115+
116+
sitemap: {
117+
hostname: 'https://actionable.lumosolutions.org'
118+
}
119+
});

‎docs/.vitepress/theme/custom.css‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/* Make the logo bigger */
2+
.VPNavBarTitle .logo {
3+
height: 40px !important; /* Default is usually 24px */
4+
width: auto;
5+
}
6+
7+
/* Alternative selector if the above doesn't work */
8+
.VPNav .VPNavBarTitle img {
9+
height: 40px !important;
10+
width: auto;
11+
}

‎docs/.vitepress/theme/index.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import './custom.css'
3+
4+
export default DefaultTheme

0 commit comments

Comments
 (0)