docs: Update TypeDoc config

foxifyjs · Nov 4, 2022 · 41cb8bd · 41cb8bd
1 parent 2312d3d
commit 41cb8bd
Show file tree

Hide file tree

Showing 54 changed files with 70 additions and 28,681 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -45,6 +45,59 @@ jobs:
             ${{ steps.changelog.outputs.changelog }}
           prerelease: ${{ steps.changelog.outputs.prerelease }}
 
+  publish-documents:
+    name: Publish Documents
+
+    needs:
+      - release
+
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    environment:
+      name: documents
+      url: ${{ steps.github-pages-deployment.outputs.page_url }}
+
+    concurrency:
+      group: ${{ github.workflow }}-documents-${{ github.ref_name }}
+      cancel-in-progress: true
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use PNPM
+        uses: pnpm/action-setup@v2
+        with:
+          version: 7
+
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v3
+        with:
+          cache: pnpm
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install dependencies
+        run: pnpm i
+
+      - name: Generate code documents
+        run: pnpm document
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docs/'
+
+      - name: Deploy to GitHub Pages
+        id: github-pages-deployment
+        uses: actions/deploy-pages@v1
+
   publish-gpr:
     name: Publish to GitHub Packages
 

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -50,6 +50,9 @@ jobs:
       - name: Build the project
         run: pnpm build
 
+      - name: Generate code documents
+        run: pnpm document
+
       - name: Get number of CPU cores
         id: cpu-cores
         uses: SimenB/github-actions-cpu-cores@v1

diff --git a/.gitignore b/.gitignore
@@ -63,3 +63,5 @@ typings/
 .vscode/
 
 *.tsbuildinfo
+
+docs/
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
diff --git a/docs/assets/css/main.css.map b/docs/assets/css/main.css.map
diff --git a/docs/assets/images/icons.png b/docs/assets/images/icons.png
diff --git a/docs/assets/images/[email protected] b/docs/assets/images/[email protected]
diff --git a/docs/assets/images/widgets.png b/docs/assets/images/widgets.png
diff --git a/docs/assets/images/[email protected] b/docs/assets/images/[email protected]
diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/accepts.html b/docs/classes/accepts.html
diff --git a/docs/classes/encapsulation.html b/docs/classes/encapsulation.html
Original file line number	Diff line number	Diff line change
Expand Up		@@ -63,3 +63,5 @@ typings/
		.vscode/

		*.tsbuildinfo

		docs/