Skip to content

Commit 2cf6f0f

Browse files
feat: initialize Link2Pay documentation with VitePress
- Set up VitePress framework with custom theme - Add comprehensive documentation structure - Getting Started guides (introduction, why-link2pay, quick-start) - Core concepts and architecture documentation - API reference with endpoint documentation - SDK documentation structure - Configure deployment for Vercel and GitHub Pages - Add contribution guidelines - Set up GitHub Actions workflow - Include custom styling matching Link2Pay brand
0 parents  commit 2cf6f0f

File tree

18 files changed

+3991
-0
lines changed

18 files changed

+3991
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Setup Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: '18'
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Build documentation
31+
run: npm run docs:build
32+
33+
- name: Upload build artifacts
34+
uses: actions/upload-artifact@v4
35+
with:
36+
name: docs-dist
37+
path: docs/.vitepress/dist
38+
39+
deploy:
40+
needs: build
41+
runs-on: ubuntu-latest
42+
if: github.ref == 'refs/heads/main'
43+
44+
permissions:
45+
contents: write
46+
47+
steps:
48+
- name: Checkout code
49+
uses: actions/checkout@v4
50+
51+
- name: Download build artifacts
52+
uses: actions/download-artifact@v4
53+
with:
54+
name: docs-dist
55+
path: docs/.vitepress/dist
56+
57+
- name: Deploy to GitHub Pages
58+
uses: peaceiris/actions-gh-pages@v3
59+
with:
60+
github_token: ${{ secrets.GITHUB_TOKEN }}
61+
publish_dir: docs/.vitepress/dist
62+
cname: docs.link2pay.dev

.gitignore

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Dependencies
2+
node_modules/
3+
package-lock.json
4+
yarn.lock
5+
pnpm-lock.yaml
6+
7+
# Build output
8+
docs/.vitepress/dist
9+
docs/.vitepress/cache
10+
.temp/
11+
12+
# IDE
13+
.vscode/*
14+
!.vscode/extensions.json
15+
.idea/
16+
*.swp
17+
*.swo
18+
*~
19+
20+
# OS
21+
.DS_Store
22+
Thumbs.db
23+
24+
# Environment
25+
.env
26+
.env.local
27+
.env.*.local
28+
29+
# Logs
30+
*.log
31+
npm-debug.log*
32+
yarn-debug.log*
33+
yarn-error.log*
34+
pnpm-debug.log*

0 commit comments

Comments
 (0)