Check for dead links at PR time and at a nightly interval (#54)

That way the doc is exempt of dead links

Author: sebastienvermeille

.github/dependabot.yml

@@ -6,7 +6,7 @@
 version: 2
 updates:
   - package-ecosystem: "github-actions"
-    directory: "/"
+    directory: ".github/workflows"
     schedule:
       interval: "daily"
   - package-ecosystem: "npm" # See documentation for possible values

.github/workflows/build.yml

@@ -22,5 +22,14 @@ jobs:
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Build documentation website
-        # Check URLs are valid, path to images, etc.
+        # Check paths are valid, markdown, etc.
         run: yarn build
+      - name: Check links
+        # exceptions can be added in .lycheeignore file
+        id: lychee
+        uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332 # v2.4.1
+        with:
+          fail: true
+          failIfEmpty: true
+          jobSummary: true
+          args: build --root-dir=${{ github.workspace }}/build --verbose --no-progress --max-redirects=20

.github/workflows/links.yml

@@ -0,0 +1,21 @@
+name: Links checker
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "00 18 * * *"
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Nightly Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332 # v2.4.1
+        with:
+          fail: true
+          failIfEmpty: true
+          jobSummary: true
+          args: --verbose --no-progress --max-redirects=10 https://nspanelmanager.com

.lycheeignore

@@ -0,0 +1,2 @@
+http://192.168.4.1
+http://localhost:8000

README.md

@@ -1,7 +1,9 @@
 # NSPanelManager Documentation
+[![Check Links](https://github.com/NSPManager/NSPanelManager-docs/actions/workflows/links.yml/badge.svg)](https://github.com/NSPManager/NSPanelManager-docs/actions/workflows/links.yml)
 
 The documentation website [nspanelmanager.com](https://nspanelmanager.com) is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
+
 ### Installation
 
 ```

package.json

@@ -44,5 +44,6 @@
   },
   "engines": {
     "node": ">=18.0"
-  }
+  },
+  "license": "LGPL-3.0-or-later"
 }