Generate and deploy documentation with Typedoc

.github/workflows/publish-docs.yml

@@ -0,0 +1,46 @@
+name: Publish documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node_version: [18.x]
+
+    steps:
+      - name: Checkout git repo
+        uses: actions/checkout@v3
+
+      - name: Install Node and NPM
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+          cache: npm
+
+      - name: Install and build
+        run: |
+          npm install
+          npm run build
+
+      - name: Build documentation
+        run: | # renaming the folders so that pages links at /{their name} instead of at /docs
+          cd ~/lib/papi-components
+          npm run build:docs
+          mv docs papi-components
+          cd ~/lib/papi-dts
+          npm run build:docs
+          mv docs papi-dts
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/[email protected]
+        with:
+          branch: github-pages
+          folder: |
+            lib/papi-components/papi-components
+            lib/papi-dts/papi-dts

lib/papi-components/.eslintignore

@@ -5,3 +5,6 @@ node_modules
 
 # Built files
 dist
+
+# Doc files
+docs

lib/papi-components/.gitignore

@@ -6,6 +6,7 @@ build
 # dist # We want these commited so developers don't need to build the package.
 dist-ssr
 *.local
+docs
 
 # logs
 logs

lib/papi-components/.prettierignore

@@ -5,3 +5,6 @@ node_modules
 
 # Built files
 dist
+
+# Doc files
+docs

lib/papi-components/.stylelintignore

@@ -5,3 +5,6 @@ node_modules
 
 # Built files
 dist
+
+# Doc files
+docs