Skip to content

Commit 32b41fa

Browse files
committed
feat: added github action for docs deployment
1 parent 2b501b2 commit 32b41fa

File tree

6 files changed

+67
-28
lines changed

6 files changed

+67
-28
lines changed

.editorconfig

Lines changed: 0 additions & 12 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
---
21
name: Nuxt [Validate]
32
env:
43
node_version: 20

.github/workflows/docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Nuxt [Docs]
2+
env:
3+
node_version: 20
4+
concurrency:
5+
group: "pages"
6+
cancel-in-progress: false
7+
on:
8+
push:
9+
branches: ["main"]
10+
workflow_dispatch:
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v4
21+
- name: Setup Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ env.node_version }}
25+
- name: Enable corepack
26+
run: corepack enable
27+
- name: Install dependencies
28+
working-directory: ./docs
29+
run: npx nypm@latest i
30+
- name: Generate documentation
31+
run: pnpm generate
32+
working-directory: ./docs
33+
- name: Upload artifact
34+
uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: ./docs/.output/public
37+
deploy:
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
runs-on: ubuntu-latest
42+
needs: build
43+
steps:
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4

.github/workflows/prerelease.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
---
21
name: Nuxt [Pre-Release]
32
env:
43
node_version: 20

.github/workflows/release.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
---
21
name: Nuxt [Release]
32
env:
43
node_version: 20

eslint.config.mjs

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
11
// @ts-check
22
import { createConfigForNuxt } from '@nuxt/eslint-config/flat'
33

4-
export default createConfigForNuxt({
5-
features: {
6-
tooling: true,
7-
stylistic: true,
4+
export default createConfigForNuxt(
5+
{
6+
features: {
7+
tooling: true,
8+
stylistic: true,
9+
},
10+
dirs: {
11+
src: ['./playground'],
12+
},
813
},
9-
dirs: {
10-
src: ['./playground'],
14+
//
15+
{
16+
rules: {
17+
'@stylistic/comma-dangle': 'off',
18+
'@stylistic/indent': 'off',
19+
'vue/no-multiple-template-root': 'off',
20+
'vue/multi-word-component-names': 'off',
21+
},
1122
},
12-
}).append({
13-
rules: {
14-
'@stylistic/comma-dangle': 'off',
15-
'@stylistic/indent': 'off',
16-
'vue/no-multiple-template-root': 'off',
17-
'vue/multi-word-component-names': 'off',
23+
//
24+
{
25+
ignores: ['docs/'],
1826
},
19-
})
27+
)

0 commit comments

Comments
 (0)