Skip to content

Commit fc94572

Browse files
authored
πŸ”€ Merge pull request #18 from docs
πŸ“ Add docs site
2 parents 3e3298d + f10cd14 commit fc94572

File tree

118 files changed

+12683
-7007
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+12683
-7007
lines changed

β€Ž.github/shared/setup-node/action.yamlβ€Ž

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@ description: "Setup Node.js environment and dependencies"
44
runs:
55
using: "composite"
66
steps:
7-
- uses: actions/setup-node@v4
7+
- name: Install pnpm
8+
uses: pnpm/action-setup@v4
9+
with:
10+
run_install: false
11+
- name: Install Node.js with cache
12+
uses: actions/setup-node@v4
813
with:
914
node-version: "lts/*"
15+
cache: 'pnpm'
1016
- name: Install Dependencies
1117
shell: bash
12-
run: npm ci
18+
run: pnpm install

β€Ž.github/workflows/lint.yamlβ€Ž

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ jobs:
77
lint:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v4
10+
- name: Checkout
11+
uses: actions/checkout@v4
1112
- uses: "./.github/shared/setup-node"
13+
# Build before test to get the SvelteKit files
14+
- name: Test build
15+
run: pnpm build
1216
- name: Lint
13-
run: npm run lint
17+
run: pnpm lint

β€Ž.github/workflows/pages.yamlβ€Ž

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy docs to GitHub Pages
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
paths:
8+
- packages/docs/**
9+
10+
# Enables manual deployments from the Actions tab
11+
workflow_dispatch:
12+
13+
# Sets permissions to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20+
# Do NOT cancel in-progress runs to allow these production deployments to complete.
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: false
24+
25+
jobs:
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
- uses: "./.github/shared/setup-node"
35+
- run: pnpm --filter "markdoc-svelte-docs" build
36+
- name: Setup Pages
37+
uses: actions/configure-pages@v5
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: build
42+
- name: Deploy to GitHub Pages
43+
id: deployment
44+
uses: actions/deploy-pages@v4

β€Ž.github/workflows/test.yamlβ€Ž

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ jobs:
77
test-svelte:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v4
10+
- name: Checkout
11+
uses: actions/checkout@v4
1112
- uses: "./.github/shared/setup-node"
12-
- name: Test
13-
run: npm run test
13+
# Build before test to get the SvelteKit files
1414
- name: Test build
15-
run: npm run build
15+
run: pnpm build
16+
- name: Test
17+
run: pnpm test

β€Ž.prettierignoreβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
dist
2+
node_modules
3+
.npmrc
4+
5+
coverage
6+
7+
pnpm-lock.yaml

0 commit comments

Comments
Β (0)