Skip to content

Commit 2381ca3

Browse files
adumesnyadumesny
committed
more doc update
1 parent a13c125 commit 2381ca3

Some content is hidden

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

69 files changed

+295
-185
lines changed

‎.github/workflows/deploy-docs.yml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
# Allow manual triggering
7+
workflow_dispatch:
8+
9+
jobs:
10+
deploy-docs:
11+
runs-on: ubuntu-latest
12+
# Only run on pushes to master (not PRs)
13+
if: github.ref == 'refs/heads/master'
14+
15+
steps:
16+
- name: Checkout repository
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: 'yarn'
26+
27+
- name: Install main dependencies
28+
run: yarn install --frozen-lockfile
29+
30+
- name: Install Angular dependencies
31+
run: |
32+
cd angular
33+
yarn install --frozen-lockfile
34+
35+
- name: Build Angular library
36+
run: yarn build:ng
37+
38+
- name: Build main library
39+
run: |
40+
grunt
41+
webpack
42+
tsc --stripInternal
43+
44+
- name: Generate all documentation
45+
run: yarn doc:all
46+
47+
- name: Prepare deployment structure
48+
run: |
49+
mkdir -p deploy
50+
51+
# Create proper directory structure for GitHub Pages
52+
mkdir -p deploy/docs/html
53+
mkdir -p deploy/angular/docs/html
54+
55+
# Copy main library HTML documentation
56+
if [ -d "docs/html" ]; then
57+
cp -r docs/html/* deploy/docs/html/
58+
fi
59+
60+
# Copy Angular library HTML documentation
61+
if [ -d "angular/docs/html" ]; then
62+
cp -r angular/docs/html/* deploy/angular/docs/html/
63+
fi
64+
65+
# Copy redirect index.html to root
66+
if [ -f "docs/index.html" ]; then
67+
cp docs/index.html deploy/
68+
fi
69+
70+
# Ensure .nojekyll exists to prevent Jekyll processing
71+
touch deploy/.nojekyll
72+
73+
# Optional: Add a simple index.html at root if none exists
74+
if [ ! -f "deploy/index.html" ]; then
75+
cat > deploy/index.html << 'EOF'
76+
<!DOCTYPE html>
77+
<html>
78+
<head>
79+
<title>GridStack.js Documentation</title>
80+
<meta http-equiv="refresh" content="0; url=./docs/html/">
81+
</head>
82+
<body>
83+
<h1>GridStack.js Documentation</h1>
84+
<p>Redirecting to <a href="./docs/html/">API Documentation</a>...</p>
85+
</body>
86+
</html>
87+
EOF
88+
fi
89+
90+
- name: Deploy to GitHub Pages
91+
uses: peaceiris/actions-gh-pages@v4
92+
with:
93+
github_token: ${{ secrets.GITHUB_TOKEN }}
94+
publish_dir: ./deploy
95+
keep_files: true
96+
commit_message: 'Deploy documentation from ${{ github.sha }}'

‎README.md

Lines changed: 1 addition & 1 deletion

‎angular/typedoc.html.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"excludePrivate": true,
2828
"excludeProtected": false,
2929
"excludeInternal": true,
30-
"includeVersion": true,
30+
"includeVersion": false,
3131
"sort": ["source-order"],
3232
"sortEntryPoints": false,
3333
"kindSortOrder": [
@@ -73,6 +73,7 @@
7373
"Angular Guide": "README.md"
7474
},
7575
"hostedBaseUrl": "https://gridstack.github.io/gridstack.js/angular/",
76+
"githubPages": true,
7677
"gitRevision": "master",
7778
"gitRemote": "origin",
7879
"name": "GridStack Angular Library"

‎angular/typedoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"excludePrivate": true,
3030
"excludeProtected": false,
3131
"excludeInternal": true,
32-
"includeVersion": true,
32+
"includeVersion": false,
3333
"sort": ["source-order"],
3434
"sortEntryPoints": false,
3535
"kindSortOrder": [

‎docs/api/index.md

Lines changed: 1 addition & 1 deletion

‎docs/html/classes/DDBaseImplement.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/html/classes/DDDraggable.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/html/classes/DDDroppable.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/html/classes/DDElement.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/html/classes/DDGridStack.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)