Merge pull request #432 from nextcloud/feat/ci-deploy-docs

Add CI for deploying documentation

Author: ChristophWurst

.github/workflows/documentation.yml

@@ -0,0 +1,32 @@
+name: Deploy documentation
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: 'package.json'
+
+      - name: Install dependencies & build
+        run: |
+          npm ci
+          npm run build:doc
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: dist/doc
+          branch: gh-pages

README.md

@@ -1,8 +1,12 @@
 # @nextcloud/logger
 
+[![npm](https://img.shields.io/npm/v/@nextcloud/logger.svg)](https://www.npmjs.com/package/@nextcloud/logger)
+[![Documentation](https://img.shields.io/badge/Documentation-online-brightgreen)](https://nextcloud.github.io/nextcloud-logger/)
+
 Generic JavaScript logging interface for Nextcloud apps and libraries
 
 ## Usage
+See also [API documentation](https://nextcloud.github.io/nextcloud-logger/).
 
 ```js
 import { getLoggerBuilder } from '@nextcloud/logger'