Skip to content

Commit c653f04

Browse files
committed
initial commit
0 parents  commit c653f04

Some content is hidden

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

44 files changed

+17740
-0
lines changed

.github/workflows/docs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy Docs
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: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Setup PNPM
25+
uses: pnpm/action-setup@v4
26+
27+
- name: Setup Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 20
31+
cache: 'pnpm'
32+
33+
- name: Install dependencies
34+
run: pnpm install --no-frozen-lockfile
35+
36+
- name: Build docs
37+
run: pnpm docs:build
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: docs/.vitepress/dist
43+
44+
deploy:
45+
needs: build
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
runs-on: ubuntu-latest
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4
54+
55+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Publish docs to org site
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
jobs:
9+
build-and-push:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- uses: pnpm/action-setup@v4
15+
16+
- uses: actions/setup-node@v4
17+
with:
18+
node-version: 20
19+
cache: pnpm
20+
21+
- run: pnpm install --no-frozen-lockfile
22+
23+
# Force org-site base (vitepress config supports DOCS_BASE override)
24+
- name: Build docs (base=/)
25+
run: |
26+
export DOCS_BASE=/
27+
pnpm docs:build
28+
29+
# Push the static site to nest-openapi/nest-openapi.github.io
30+
- name: Push to site repo (via deploy key)
31+
uses: cpina/github-action-push-to-another-repository@v1.7.2
32+
env:
33+
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
34+
with:
35+
source-directory: docs/.vitepress/dist
36+
destination-github-username: nest-openapi
37+
destination-repository-name: nest-openapi.github.io
38+
user-email: github-actions@users.noreply.github.com
39+
target-branch: main

.gitignore

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Dependencies
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
lerna-debug.log*
7+
8+
# Build output
9+
dist
10+
11+
# Runtime data
12+
pids
13+
*.pid
14+
*.seed
15+
*.pid.lock
16+
17+
# Coverage directory used by tools like istanbul
18+
coverage/
19+
*.lcov
20+
21+
# nyc test coverage
22+
.nyc_output
23+
24+
# node-waf configuration
25+
.lock-wscript
26+
27+
# Compiled binary addons (https://nodejs.org/api/addons.html)
28+
build/Release
29+
30+
# TypeScript v1 declaration files
31+
typings/
32+
33+
# TypeScript cache
34+
*.tsbuildinfo
35+
36+
# Optional npm cache directory
37+
.npm
38+
39+
# Optional eslint cache
40+
.eslintcache
41+
42+
# Microbundle cache
43+
.rpt2_cache/
44+
.rts2_cache_cjs/
45+
.rts2_cache_es/
46+
.rts2_cache_umd/
47+
48+
# Optional REPL history
49+
.node_repl_history
50+
51+
# Output of 'npm pack'
52+
*.tgz
53+
54+
# Yarn Integrity file
55+
.yarn-integrity
56+
57+
# dotenv environment variables file
58+
.env
59+
.env.test
60+
.env.production
61+
62+
# vuepress/vitepress build output
63+
*/.vitepress/cache/
64+
65+
# Serverless directories
66+
.serverless/
67+
68+
# FuseBox cache
69+
.fusebox/
70+
71+
# Stores VSCode versions used for testing VSCode extensions
72+
.vscode-test
73+
74+
# yarn v2
75+
.yarn/cache
76+
.yarn/unplugged
77+
.yarn/build-state.yml
78+
.yarn/install-state.gz
79+
.pnp.*
80+
81+
# IDE
82+
.vscode/
83+
.idea/
84+
.cursor/
85+
*.swp
86+
*.swo
87+
*~
88+
89+
# OS
90+
.DS_Store
91+
Thumbs.db

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 nest-openapi
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)