Compare commits

..
Author SHA1 Message Date
ajnart 3131b9d923 fix(docs): generate valid integration links 2026-09-06 09:50:52 +02:00
4 changed files with 62 additions and 40 deletions

No files matched your search

+8 -8
View File
@@ -74,7 +74,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/archiveteam-warrior" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png" alt="ArchiveTeam Warrior" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/selfhst/icons/png/archiveteam-warrior.png" alt="ArchiveTeam Warrior" width="90" height="90" />
<br/> <br/>
<p align="center">ArchiveTeam<br/>Warrior</p> <p align="center">ArchiveTeam<br/>Warrior</p>
@@ -88,7 +88,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/audiobookshelf" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/audiobookshelf.svg" alt="Audiobookshelf" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/audiobookshelf.svg" alt="Audiobookshelf" width="90" height="90" />
<br/> <br/>
<p align="center">Audiobookshelf</p> <p align="center">Audiobookshelf</p>
@@ -137,7 +137,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/glances" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/glances.svg" alt="Glances" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/glances.svg" alt="Glances" width="90" height="90" />
<br/> <br/>
<p align="center">Glances</p> <p align="center">Glances</p>
@@ -200,7 +200,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/navidrome" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/navidrome.svg" alt="Navidrome" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/navidrome.svg" alt="Navidrome" width="90" height="90" />
<br/> <br/>
<p align="center">Navidrome</p> <p align="center">Navidrome</p>
@@ -249,7 +249,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/paperless-ngx" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/paperless-ngx.svg" alt="Paperless-ngx" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/paperless-ngx.svg" alt="Paperless-ngx" width="90" height="90" />
<br/> <br/>
<p align="center">Paperless-ngx</p> <p align="center">Paperless-ngx</p>
@@ -263,7 +263,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/peanut" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/peanut.svg" alt="PeaNUT" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/peanut.svg" alt="PeaNUT" width="90" height="90" />
<br/> <br/>
<p align="center">PeaNUT</p> <p align="center">PeaNUT</p>
@@ -313,7 +313,7 @@
</td> </td>
<td align="center"> <td align="center">
<a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/readarr.svg" alt="Readarr" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@main/png/readarr.png" alt="Readarr" width="90" height="90" />
<br/> <br/>
<p align="center">Readarr</p> <p align="center">Readarr</p>
</a> </a>
@@ -424,7 +424,7 @@
</a> </a>
</td> </td>
<td align="center"> <td align="center">
<a href="null" target="_blank" rel="noreferrer noopener"> <a href="https://homarr.dev/docs/integrations/uptime-kuma" target="_blank" rel="noreferrer noopener">
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/uptime-kuma.svg" alt="Uptime Kuma" width="90" height="90" /> <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/uptime-kuma.svg" alt="Uptime Kuma" width="90" height="90" />
<br/> <br/>
<p align="center">Uptime<br/>Kuma</p> <p align="center">Uptime<br/>Kuma</p>
+29 -23
View File
@@ -696,7 +696,6 @@ overrides:
linkifyjs@<4.3.2: '>=4.3.3' linkifyjs@<4.3.2: '>=4.3.3'
nanoid@>=4.0.0 <5.0.9: '>=5.1.16' nanoid@>=4.0.0 <5.0.9: '>=5.1.16'
prismjs@<1.30.0: '>=1.30.0' prismjs@<1.30.0: '>=1.30.0'
protobufjs@<7.5.5: '>=7.5.5 <8'
proxmox-api>undici: 7.28.0 proxmox-api>undici: 7.28.0
react-is: ^19.2.7 react-is: ^19.2.7
rollup@>=4.0.0 <4.22.4: '>=4.62.2' rollup@>=4.0.0 <4.22.4: '>=4.62.2'
@@ -7088,26 +7087,29 @@ packages:
'@protobufjs/base64@1.1.2': '@protobufjs/base64@1.1.2':
resolution: {integrity: sha512-AZkcAA5vnN/v4PDqKyMR5lx7hZttPDgClv83E//FMNhR2TMcLUhfRUBHCmSl0oi9zMgDDqRUJkSxO3wm85+XLg==} resolution: {integrity: sha512-AZkcAA5vnN/v4PDqKyMR5lx7hZttPDgClv83E//FMNhR2TMcLUhfRUBHCmSl0oi9zMgDDqRUJkSxO3wm85+XLg==}
'@protobufjs/codegen@2.0.5': '@protobufjs/codegen@2.0.4':
resolution: {integrity: sha512-zgXFLzW3Ap33e6d0Wlj4MGIm6Ce8O89n/apUaGNB/jx+hw+ruWEp7EwGUshdLKVRCxZW12fp9r40E1mQrf/34g==} resolution: {integrity: sha512-YyFaikqM5sH0ziFZCN3xDC7zeGaB/d0IUb9CATugHWbd1FRFwWwt4ld4OYMPWu5a3Xe01mGAULCdqhMlPl29Jg==}
'@protobufjs/eventemitter@1.1.1': '@protobufjs/eventemitter@1.1.0':
resolution: {integrity: sha512-vW1GmwMZNnL+gMRaovlh9yZX74kc+TTU3FObkkurpMaRtBfLP3ldjS9KQWlwZgraRE0+dheEEoAxdzcJQ8eXZg==} resolution: {integrity: sha512-j9ednRT81vYJ9OfVuXG6ERSTdEL1xVsNgqpkxMsbIabzSo3goCjDIveeGv5d03om39ML71RdmrGNjG5SReBP/Q==}
'@protobufjs/fetch@1.1.1': '@protobufjs/fetch@1.1.0':
resolution: {integrity: sha512-GpptLrs57adMSuHi3VNj0mAF8dwh36LMaYF6XyJ6JMWlVsc+t42tm1HSEDmOs3A8fC9yyeisgLhsTVQokOZ0zw==} resolution: {integrity: sha512-lljVXpqXebpsijW71PZaCYeIcE5on1w5DlQy5WH6GLbFryLUrBD4932W/E2BSpfRJWseIL4v/KPgBFxDOIdKpQ==}
'@protobufjs/float@1.0.2': '@protobufjs/float@1.0.2':
resolution: {integrity: sha512-Ddb+kVXlXst9d+R9PfTIxh1EdNkgoRe5tOX6t01f1lYWOvJnSPDBlG241QLzcyPdoNTsblLUdujGSE4RzrTZGQ==} resolution: {integrity: sha512-Ddb+kVXlXst9d+R9PfTIxh1EdNkgoRe5tOX6t01f1lYWOvJnSPDBlG241QLzcyPdoNTsblLUdujGSE4RzrTZGQ==}
'@protobufjs/inquire@1.1.0':
resolution: {integrity: sha512-kdSefcPdruJiFMVSbn801t4vFK7KB/5gd2fYvrxhuJYg8ILrmn9SKSX2tZdV6V+ksulWqS7aXjBcRXl3wHoD9Q==}
'@protobufjs/path@1.1.2': '@protobufjs/path@1.1.2':
resolution: {integrity: sha512-6JOcJ5Tm08dOHAbdR3GrvP+yUUfkjG5ePsHYczMFLq3ZmMkAD98cDgcT2iA1lJ9NVwFd4tH/iSSoe44YWkltEA==} resolution: {integrity: sha512-6JOcJ5Tm08dOHAbdR3GrvP+yUUfkjG5ePsHYczMFLq3ZmMkAD98cDgcT2iA1lJ9NVwFd4tH/iSSoe44YWkltEA==}
'@protobufjs/pool@1.1.0': '@protobufjs/pool@1.1.0':
resolution: {integrity: sha512-0kELaGSIDBKvcgS4zkjz1PeddatrjYcmMWOlAuAPwAeccUrPHdUqo/J6LiymHHEiJT5NrF1UVwxY14f+fy4WQw==} resolution: {integrity: sha512-0kELaGSIDBKvcgS4zkjz1PeddatrjYcmMWOlAuAPwAeccUrPHdUqo/J6LiymHHEiJT5NrF1UVwxY14f+fy4WQw==}
'@protobufjs/utf8@1.1.2': '@protobufjs/utf8@1.1.0':
resolution: {integrity: sha512-b1UQwcEZ4yCnMCD8DAL1VlbvBJE9/IX4FTIp7BG1xYpf29SLazLSrqUkj4w7Y5y7cCVP6E5tcqqcI0xemPkHug==} resolution: {integrity: sha512-Vvn3zZrhQZkkBE8LSuW3em98c0FwgO4nxzv6OdSxPKJIEKY2bGbHn+mhGIPerzI4twdxaP8/0+06HBpwf345Lw==}
'@pwshub/bellajs@13.0.2': '@pwshub/bellajs@13.0.2':
resolution: {integrity: sha512-OWOaE7Ieufo7VMv957iahOzv/w5oXyyXO28Jh2x6rLU96ZLqC508kAKTgdMJRXgVjda2s+/0C6Kno+k16OmJsQ==} resolution: {integrity: sha512-OWOaE7Ieufo7VMv957iahOzv/w5oXyyXO28Jh2x6rLU96ZLqC508kAKTgdMJRXgVjda2s+/0C6Kno+k16OmJsQ==}
@@ -14883,8 +14885,8 @@ packages:
proto-list@1.2.4: proto-list@1.2.4:
resolution: {integrity: sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==} resolution: {integrity: sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==}
protobufjs@7.6.6: protobufjs@7.4.0:
resolution: {integrity: sha512-dYDWdjSl5RNb7SgPxGQcRU+GtvP7s2fpkrY0r432PcOIaZ0/rBcxEZnQN67iJhFuQiVw754JDoPruPCNdGsbjg==} resolution: {integrity: sha512-mRUWCc3KUU4w1jU8sGxICXH/gNS94DvI1gxqDvBzhj1JpcsimQkYiOJfwsPUykUI5ZaspFbSgmBLER8IrQ3tqw==}
engines: {node: '>=12.0.0'} engines: {node: '>=12.0.0'}
proxmox-api@1.1.1: proxmox-api@1.1.1:
@@ -20814,7 +20816,7 @@ snapshots:
dependencies: dependencies:
lodash.camelcase: 4.3.0 lodash.camelcase: 4.3.0
long: 5.3.2 long: 5.3.2
protobufjs: 7.6.6 protobufjs: 7.4.0
yargs: 17.7.2 yargs: 17.7.2
'@hapi/bourne@3.0.0': {} '@hapi/bourne@3.0.0': {}
@@ -22509,21 +22511,24 @@ snapshots:
'@protobufjs/base64@1.1.2': {} '@protobufjs/base64@1.1.2': {}
'@protobufjs/codegen@2.0.5': {} '@protobufjs/codegen@2.0.4': {}
'@protobufjs/eventemitter@1.1.1': {} '@protobufjs/eventemitter@1.1.0': {}
'@protobufjs/fetch@1.1.1': '@protobufjs/fetch@1.1.0':
dependencies: dependencies:
'@protobufjs/aspromise': 1.1.2 '@protobufjs/aspromise': 1.1.2
'@protobufjs/inquire': 1.1.0
'@protobufjs/float@1.0.2': {} '@protobufjs/float@1.0.2': {}
'@protobufjs/inquire@1.1.0': {}
'@protobufjs/path@1.1.2': {} '@protobufjs/path@1.1.2': {}
'@protobufjs/pool@1.1.0': {} '@protobufjs/pool@1.1.0': {}
'@protobufjs/utf8@1.1.2': {} '@protobufjs/utf8@1.1.0': {}
'@pwshub/bellajs@13.0.2': {} '@pwshub/bellajs@13.0.2': {}
@@ -27178,7 +27183,7 @@ snapshots:
'@grpc/grpc-js': 1.12.5 '@grpc/grpc-js': 1.12.5
'@grpc/proto-loader': 0.7.13 '@grpc/proto-loader': 0.7.13
docker-modem: 5.0.7(supports-color@10.2.2) docker-modem: 5.0.7(supports-color@10.2.2)
protobufjs: 7.6.6 protobufjs: 7.4.0
tar-fs: 2.1.4 tar-fs: 2.1.4
transitivePeerDependencies: transitivePeerDependencies:
- supports-color - supports-color
@@ -27189,7 +27194,7 @@ snapshots:
'@grpc/grpc-js': 1.12.5 '@grpc/grpc-js': 1.12.5
'@grpc/proto-loader': 0.7.13 '@grpc/proto-loader': 0.7.13
docker-modem: 5.0.7(supports-color@10.2.2) docker-modem: 5.0.7(supports-color@10.2.2)
protobufjs: 7.6.6 protobufjs: 7.4.0
tar-fs: 2.1.4 tar-fs: 2.1.4
transitivePeerDependencies: transitivePeerDependencies:
- supports-color - supports-color
@@ -31426,17 +31431,18 @@ snapshots:
proto-list@1.2.4: {} proto-list@1.2.4: {}
protobufjs@7.6.6: protobufjs@7.4.0:
dependencies: dependencies:
'@protobufjs/aspromise': 1.1.2 '@protobufjs/aspromise': 1.1.2
'@protobufjs/base64': 1.1.2 '@protobufjs/base64': 1.1.2
'@protobufjs/codegen': 2.0.5 '@protobufjs/codegen': 2.0.4
'@protobufjs/eventemitter': 1.1.1 '@protobufjs/eventemitter': 1.1.0
'@protobufjs/fetch': 1.1.1 '@protobufjs/fetch': 1.1.0
'@protobufjs/float': 1.0.2 '@protobufjs/float': 1.0.2
'@protobufjs/inquire': 1.1.0
'@protobufjs/path': 1.1.2 '@protobufjs/path': 1.1.2
'@protobufjs/pool': 1.1.0 '@protobufjs/pool': 1.1.0
'@protobufjs/utf8': 1.1.2 '@protobufjs/utf8': 1.1.0
'@types/node': 24.13.3 '@types/node': 24.13.3
long: 5.3.2 long: 5.3.2
-1
View File
@@ -260,7 +260,6 @@ overrides:
"linkifyjs@<4.3.2": ">=4.3.3" "linkifyjs@<4.3.2": ">=4.3.3"
"nanoid@>=4.0.0 <5.0.9": ">=5.1.16" "nanoid@>=4.0.0 <5.0.9": ">=5.1.16"
"prismjs@<1.30.0": ">=1.30.0" "prismjs@<1.30.0": ">=1.30.0"
"protobufjs@<7.5.5": ">=7.5.5 <8"
"proxmox-api>undici": "7.28.0" "proxmox-api>undici": "7.28.0"
"react-is": "^19.2.7" "react-is": "^19.2.7"
"rollup@>=4.0.0 <4.22.4": ">=4.62.2" "rollup@>=4.0.0 <4.22.4": ">=4.62.2"
+25 -8
View File
@@ -1,5 +1,9 @@
import { readFile, writeFile } from "fs/promises"; import { readFile, writeFile } from "fs/promises";
import { integrationDefs } from "../packages/definitions/src/integration"; import {
getIntegrationDocumentationUrl,
integrationDefs,
integrationKinds,
} from "../packages/definitions/src/integration";
const FILE = "docs/README.md"; const FILE = "docs/README.md";
const MAX_COLUMNS_PER_ROW = 7; const MAX_COLUMNS_PER_ROW = 7;
@@ -21,19 +25,29 @@ async function updateIntegrationList() {
} }
// Generate the new integration list // Generate the new integration list
const integrations = Object.values(integrationDefs) const integrations = integrationKinds
.filter((def) => def.name !== "Mock") .filter((kind) => kind !== "mock")
.sort((a, b) => a.name.localeCompare(b.name)); .map((kind) => ({
...integrationDefs[kind],
documentationUrl: getIntegrationDocumentationUrl(kind),
}))
.toSorted((a, b) => a.name.localeCompare(b.name));
const tableRows: string[] = []; const tableRows: string[] = [];
let currentRow: string[] = []; let currentRow: string[] = [];
integrations.forEach((integration) => { integrations.forEach((integration) => {
currentRow.push(`<td align="center"> const cellBody = `
<a href="${integration.documentationUrl}" target="_blank" rel="noreferrer noopener">
<img src="${integration.iconUrl}" alt="${integration.name}" width="90" height="90" /> <img src="${integration.iconUrl}" alt="${integration.name}" width="90" height="90" />
<br/> <br/>
<p align="center">${integration.name.replaceAll(" ", "<br/>")}</p> <p align="center">${integration.name.replaceAll(" ", "<br/>")}</p>
</a> `;
let cellContent = `<div>${cellBody}</div>`;
if (integration.documentationUrl !== null) {
cellContent = `<a href="${integration.documentationUrl}" target="_blank" rel="noreferrer noopener">${cellBody}</a>`;
}
currentRow.push(`<td align="center">
${cellContent}
</td>`); </td>`);
if (currentRow.length === MAX_COLUMNS_PER_ROW) { if (currentRow.length === MAX_COLUMNS_PER_ROW) {
@@ -67,4 +81,7 @@ ${endMarker}`;
await writeFile(FILE, newContent, "utf8"); await writeFile(FILE, newContent, "utf8");
} }
updateIntegrationList().catch(console.error); updateIntegrationList().catch((error: unknown) => {
console.error(error);
process.exitCode = 1;
});