Set up documentation site for v4 (#191)

Set up documentation site on GitHub pages.

Build with `typedoc` which handles updated TypeScript types much better.

.github/workflows/ci.yaml

@@ -115,6 +115,10 @@ jobs:
     runs-on: ubuntu-latest
     environment: integration-suite
 
+    concurrency:
+      group: integration
+      cancel-in-progress: false
+
     strategy:
       fail-fast: true
       max-parallel: 1

.github/workflows/docs-site.yaml

@@ -0,0 +1,53 @@
+name: Deploy documentation site
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Install dependencies
+        run: |
+          npm ci
+
+      - name: Build docs site
+        run: |
+          npm run docs-site
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: './gh-pages'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -1,3 +1,4 @@
+/gh-pages/
 /types/
 /node_modules/
 .DS_Store

CHANGELOG.md

@@ -7,6 +7,10 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+
+- Build updated docs site at https://tumblr.github.io/tumblr.js.
+
 ### Changed
 
 - Some `@private` properties of `Client` have been changed to `#private` fields.

README.md

@@ -4,6 +4,7 @@
 [![npm](https://img.shields.io/npm/v/tumblr.js)][npm-package]
 
 The official JavaScript client library for the [Tumblr API](http://www.tumblr.com/docs/api/v2).
+[Check out the detailed documentation here](https://tumblr.github.io/tumblr.js/).
 
 ## Installation