Skip to content

Commit c6dcb71

Browse files
committed
Workflow for typedocs of master sources
1 parent c44bd9d commit c6dcb71

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/workflows/docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- feature/tsdoc
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19+
concurrency:
20+
group: "pages"
21+
cancel-in-progress: false
22+
23+
jobs:
24+
docs:
25+
environment:
26+
name: github-pages
27+
url: ${{ steps.deployment.outputs.page_url }}
28+
runs-on: ubuntu-latest
29+
name: Generate Code Docs
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
with:
34+
repository: mathjax/mathjax-src
35+
36+
- uses: pnpm/action-setup@v4
37+
name: Install pnpm
38+
with:
39+
version: 10
40+
run_install: false
41+
42+
- name: Install packages
43+
run: pnpm i
44+
45+
- name: Build docs
46+
run: pnpm typedoc
47+
48+
- name: Upload artifact
49+
uses: actions/upload-pages-artifact@v3
50+
with:
51+
# Upload docs folder
52+
path: './docs'
53+
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)