chore(docs): Deploy docs to GitHub pages

fb55 · Dec 31, 2020 · e583311 · e583311
1 parent adef5b4
commit e583311
Show file tree

Hide file tree

Showing 16 changed files with 151 additions and 971 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml
@@ -0,0 +1,39 @@
+name: Deploy to GitHub Pages
+on:
+    push:
+        branches:
+            - main
+
+env:
+    CI: true
+    FORCE_COLOR: 2
+    NODE: 14
+
+jobs:
+    deploy:
+        name: Deploy to GitHub Pages
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: "${{ env.NODE }}"
+            - name: Set up npm cache
+              uses: actions/cache@v2
+              with:
+                  path: ~/.npm
+                  key: ${{ runner.os }}-node-v${{ env.NODE }}-${{ hashFiles('package.json') }}-${{ hashFiles('package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.OS }}-node-v${{ env.NODE }}-${{ hashFiles('package.json') }}-${{ hashFiles('package-lock.json') }}
+                      ${{ runner.OS }}-node-v${{ env.NODE }}-
+            - run: npm ci
+            - name: Build docs
+              run: npm run build:docs
+            - name: Deploy
+              uses: s0/[email protected]
+              env:
+                  REPO: self
+                  BRANCH: gh-pages
+                  FOLDER: docs
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  SKIP_EMPTY_COMMITS: true
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .vscode/
+docs/
 node_modules/
 coverage/
 lib/
diff --git a/.prettierignore b/.prettierignore
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/enums/_helpers_.documentposition.md b/docs/enums/_helpers_.documentposition.md
diff --git a/docs/modules/_helpers_.md b/docs/modules/_helpers_.md
diff --git a/docs/modules/_legacy_.md b/docs/modules/_legacy_.md