build: GitHub actions to generate documentation (#3)

.github/workflows/tsdoc.yml

@@ -0,0 +1,29 @@
+# A GitHub Actions workflow that generates the documentation for pull requests
+
+name: tsdoc-markdown
+
+on:
+  push:
+
+jobs:
+  docs:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate docs
+        run: npm run docs
+
+      - name: Commit docs
+        uses: EndBug/add-and-commit@v9
+        # We don't want to commit documentation changes to main
+        if: ${{ github.ref != 'refs/heads/main' }}
+        with:
+          add: .
+          default_author: github_actions
+          message: '🤖 Documentation auto-update'

README.md

@@ -10,6 +10,10 @@ Install the library in your project from [npm](https://www.npmjs.com/package/tsd
 npm install -D tsdoc-markdown
 ```
 
+## GitHub Actions
+
+A GitHub Actions workflow that generates the documentation for pull requests using this library is available in [tsdoc.yml](/.github/workflows/tsdoc.yml).
+
 ## Usage
 
 This tool is shipped with a NodeJS [bin](/bin/index.js) script that can be executed with the shortcut `tsdoc`.
@@ -71,7 +75,7 @@ generateDocumentation({
 
 <br/>
 
-*Note: Chapter "Functions" is auto-generated with `tsdoc-markdown`.*
+_Note: Chapter "Functions" is auto-generated with `tsdoc-markdown`._
 
 <!-- TSDOC_START -->