Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Deploy Documentation

on:
push:
branches: [ master ]
# Allow manual triggering
workflow_dispatch:

jobs:
deploy-docs:
runs-on: ubuntu-latest
# Only run on pushes to master (not PRs)
if: github.ref == 'refs/heads/master'

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
cache: 'yarn'

- name: Install main dependencies
run: yarn install --frozen-lockfile

- name: Install Angular dependencies
run: |
cd angular
yarn install --frozen-lockfile

- name: Build Angular library
run: yarn build:ng

- name: Build main library
run: |
grunt
webpack
tsc --stripInternal

- name: Generate all documentation
run: yarn doc:all

- name: Prepare deployment structure
run: |
mkdir -p deploy

# Create proper directory structure for GitHub Pages
mkdir -p deploy/docs/html
mkdir -p deploy/angular/docs/html

# Copy main library HTML documentation
if [ -d "docs/html" ]; then
cp -r docs/html/* deploy/docs/html/
fi

# Copy Angular library HTML documentation
if [ -d "angular/docs/html" ]; then
cp -r angular/docs/html/* deploy/angular/docs/html/
fi

# Copy redirect index.html to root
if [ -f "docs/index.html" ]; then
cp docs/index.html deploy/
fi

# Ensure .nojekyll exists to prevent Jekyll processing
touch deploy/.nojekyll

# Optional: Add a simple index.html at root if none exists
if [ ! -f "deploy/index.html" ]; then
cat > deploy/index.html << 'EOF'
<!DOCTYPE html>
<html>
<head>
<title>GridStack.js Documentation</title>
<meta http-equiv="refresh" content="0; url=./docs/html/">
</head>
<body>
<h1>GridStack.js Documentation</h1>
<p>Redirecting to <a href="./docs/html/">API Documentation</a>...</p>
</body>
</html>
EOF
fi

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./deploy
keep_files: true
commit_message: 'Deploy documentation from ${{ github.sha }}'
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Join us on Slack: [https://gridstackjs.slack.com](https://join.slack.com/t/grids

# Demo and API Documentation

Please visit http://gridstackjs.com and [these demos](http://gridstackjs.com/demo/), and complete [API documentation](https://github.com/gridstack/gridstack.js/tree/master/doc)
Please visit http://gridstackjs.com and [these demos](http://gridstackjs.com/demo/), and complete [API documentation](https://gridstack.github.io/gridstack.js/docs/html/) ([markdown](https://github.com/gridstack/gridstack.js/tree/master/doc))

# Usage

Expand Down
3 changes: 2 additions & 1 deletion angular/typedoc.html.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"excludePrivate": true,
"excludeProtected": false,
"excludeInternal": true,
"includeVersion": true,
"includeVersion": false,
"sort": ["source-order"],
"sortEntryPoints": false,
"kindSortOrder": [
Expand Down Expand Up @@ -73,6 +73,7 @@
"Angular Guide": "README.md"
},
"hostedBaseUrl": "https://gridstack.github.io/gridstack.js/angular/",
"githubPages": true,
"gitRevision": "master",
"gitRemote": "origin",
"name": "GridStack Angular Library"
Expand Down
2 changes: 1 addition & 1 deletion angular/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"excludePrivate": true,
"excludeProtected": false,
"excludeInternal": true,
"includeVersion": true,
"includeVersion": false,
"sort": ["source-order"],
"sortEntryPoints": false,
"kindSortOrder": [
Expand Down
2 changes: 1 addition & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# gridstack v12.3.0
# gridstack

## Classes

Expand Down
4 changes: 2 additions & 2 deletions docs/html/classes/DDBaseImplement.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDDraggable.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDDroppable.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDElement.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDGridStack.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDManager.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDResizable.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/DDResizableHandle.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/GridStack.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/GridStackEngine.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/classes/Utils.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/hierarchy.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Breakpoint.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/CellPosition.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDDragOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDDroppableOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDElementHost.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDRemoveOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDResizableHandleOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDResizableOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDResizeOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DDUIData.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/DragTransform.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridHTMLElement.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridItemHTMLElement.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridStackEngineOptions.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridStackMoveOpts.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridStackNode.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridStackOptions.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridStackPosition.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/GridStackWidget.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/HTMLElementExtendOpt.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/HeightData.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/MousePosition.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Position.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Rect.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Responsive.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/interfaces/Size.html

Large diffs are not rendered by default.

Loading