jazzymc/homarr
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Replace entire codebase with homarr-labs/homarr

Browse Source
This commit is contained in:
Thomas Camlong
2026-01-15 21:54:44 +01:00
parent c5bc3b1559
commit 4fdd1fe351
4666 changed files with 409577 additions and 147434 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
packages/definitions/src/docs/codegen.ts Normal file
View File

@@ -0,0 +1,75 @@
import fs from "node:fs/promises";
import path, { dirname } from "node:path";
import { fileURLToPath } from "node:url";
import { XMLParser } from "fast-xml-parser";
import { z } from "zod/v4";
import { createDocumentationLink } from "./index";
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
const removeCommonUrl = (url: string) => {
return url.replace("https://homarr.dev", "");
};
const sitemapSchema = z.object({
urlset: z.object({
url: z.array(
z.object({
loc: z.string(),
}),
),
}),
});
const fetchSitemapAsync = async () => {
const response = await fetch(createDocumentationLink("/sitemap.xml"));
return await response.text();
};
const parseXml = (sitemapXml: string) => {
const parser = new XMLParser();
const data: unknown = parser.parse(sitemapXml);
const result = sitemapSchema.safeParse(data);
if (!result.success) {
throw new Error("Invalid sitemap schema");
}
return result.data;
};
const mapSitemapXmlToPaths = (sitemapData: z.infer<typeof sitemapSchema>) => {
return sitemapData.urlset.url.map((url) => removeCommonUrl(url.loc));
};
const createSitemapPathType = (paths: string[]) => {
return "export type HomarrDocumentationPath =\n" + paths.map((path) => ` | "${path.replace(/\/$/, "")}"`).join("\n");
};
const updateSitemapTypeFileAsync = async (sitemapPathType: string) => {
const content =
"// This file is auto-generated by the codegen script\n" +
"// it uses the sitemap.xml to generate the HomarrDocumentationPath type\n" +
sitemapPathType +
";\n";
await fs.writeFile(path.join(__dirname, "homarr-docs-sitemap.ts"), content);
};
/**
* This script fetches the sitemap.xml and generates the HomarrDocumentationPath type
* which is used for typesafe documentation links
*/
// eslint-disable-next-line no-restricted-syntax
const main = async () => {
const sitemapXml = await fetchSitemapAsync();
const sitemapData = parseXml(sitemapXml);
const paths = mapSitemapXmlToPaths(sitemapData);
// Adding sitemap as it's not in the sitemap.xml and we need it for this file
paths.push("/sitemap.xml");
const sitemapPathType = createSitemapPathType(paths);
await updateSitemapTypeFileAsync(sitemapPathType);
};
void main();

233
packages/definitions/src/docs/homarr-docs-sitemap.ts Normal file
View File

@@ -0,0 +1,233 @@
// This file is auto-generated by the codegen script
// it uses the sitemap.xml to generate the HomarrDocumentationPath type
export type HomarrDocumentationPath =
| "/about-us"
| "/blog"
| "/blog/2023/01/11/version0.11"
| "/blog/2023/04/16/version0.12-more-widgets"
| "/blog/2023/11/10/authentication"
| "/blog/2023/12/22/updated-documentation"
| "/blog/2024/09/23/version-1.0"
| "/blog/2024/12/17/open-beta-1.0"
| "/blog/2025/01/19/migration-guide-1.0"
| "/blog/2025/08/02/using-argus"
| "/blog/archive"
| "/blog/authors"
| "/blog/authors/ajnart"
| "/blog/authors/manuel-rw"
| "/blog/authors/meierschlumpf"
| "/blog/authors/tagashi"
| "/blog/authors/walkx"
| "/blog/documentation-migration"
| "/blog/tags"
| "/blog/tags/authentication"
| "/blog/tags/breaking-changes"
| "/blog/tags/contributions"
| "/blog/tags/design"
| "/blog/tags/dnd"
| "/blog/tags/docs"
| "/blog/tags/documentation"
| "/blog/tags/gridstack"
| "/blog/tags/homarr"
| "/blog/tags/migration"
| "/blog/tags/notepad"
| "/blog/tags/security"
| "/blog/tags/translations"
| "/blog/tags/update"
| "/blog/tags/version"
| "/blog/translations"
| "/search"
| "/docs/tags"
| "/docs/tags/active-directory"
| "/docs/tags/administration"
| "/docs/tags/advanced"
| "/docs/tags/analytics"
| "/docs/tags/api"
| "/docs/tags/apps"
| "/docs/tags/background"
| "/docs/tags/boards"
| "/docs/tags/bookmarks"
| "/docs/tags/caddy"
| "/docs/tags/certificates"
| "/docs/tags/code"
| "/docs/tags/community"
| "/docs/tags/configuration"
| "/docs/tags/connections"
| "/docs/tags/customization"
| "/docs/tags/data-sources"
| "/docs/tags/database"
| "/docs/tags/developer"
| "/docs/tags/development"
| "/docs/tags/docker"
| "/docs/tags/donation"
| "/docs/tags/edit-mode"
| "/docs/tags/env"
| "/docs/tags/environment-variables"
| "/docs/tags/getting-started"
| "/docs/tags/google"
| "/docs/tags/groups"
| "/docs/tags/help"
| "/docs/tags/icon-picker"
| "/docs/tags/icon-repositories"
| "/docs/tags/icons"
| "/docs/tags/installation"
| "/docs/tags/integration"
| "/docs/tags/integrations"
| "/docs/tags/interface"
| "/docs/tags/jobs"
| "/docs/tags/layout"
| "/docs/tags/ldap"
| "/docs/tags/management"
| "/docs/tags/media"
| "/docs/tags/oidc"
| "/docs/tags/open-collective"
| "/docs/tags/permissions"
| "/docs/tags/pgid"
| "/docs/tags/ping"
| "/docs/tags/programming"
| "/docs/tags/proxy"
| "/docs/tags/puid"
| "/docs/tags/redis"
| "/docs/tags/responsive"
| "/docs/tags/roles"
| "/docs/tags/search"
| "/docs/tags/search-engines"
| "/docs/tags/security"
| "/docs/tags/self-signed"
| "/docs/tags/seo"
| "/docs/tags/server"
| "/docs/tags/settings"
| "/docs/tags/sso"
| "/docs/tags/tasks"
| "/docs/tags/technical-documentation"
| "/docs/tags/traefik"
| "/docs/tags/translations"
| "/docs/tags/unraid"
| "/docs/tags/uploads"
| "/docs/tags/users"
| "/docs/tags/variables"
| "/docs/advanced/command-line"
| "/docs/advanced/command-line/fix-usernames"
| "/docs/advanced/command-line/password-recovery"
| "/docs/advanced/development/getting-started"
| "/docs/advanced/development/kubernetes"
| "/docs/advanced/environment-variables"
| "/docs/advanced/icons"
| "/docs/advanced/keyboard-shortcuts"
| "/docs/advanced/proxy"
| "/docs/advanced/running-as-different-user"
| "/docs/advanced/single-sign-on"
| "/docs/advanced/styling"
| "/docs/category/advanced"
| "/docs/category/community"
| "/docs/category/developer-guides"
| "/docs/category/getting-started"
| "/docs/category/installation"
| "/docs/category/installation-1"
| "/docs/category/integrations"
| "/docs/category/management"
| "/docs/category/widgets"
| "/docs/community/donate"
| "/docs/community/faq"
| "/docs/community/get-in-touch"
| "/docs/community/license"
| "/docs/community/translations"
| "/docs/getting-started"
| "/docs/getting-started/after-the-installation"
| "/docs/getting-started/glossary"
| "/docs/getting-started/installation/docker"
| "/docs/getting-started/installation/easy-panel"
| "/docs/getting-started/installation/helm"
| "/docs/getting-started/installation/home-assistant"
| "/docs/getting-started/installation/pika-pods"
| "/docs/getting-started/installation/portainer"
| "/docs/getting-started/installation/proxmox"
| "/docs/getting-started/installation/qnap"
| "/docs/getting-started/installation/railway"
| "/docs/getting-started/installation/runtipi"
| "/docs/getting-started/installation/saltbox"
| "/docs/getting-started/installation/source"
| "/docs/getting-started/installation/synology"
| "/docs/getting-started/installation/unraid"
| "/docs/integrations/adguard-home"
| "/docs/integrations/aria2"
| "/docs/integrations/codeberg"
| "/docs/integrations/dash-dot"
| "/docs/integrations/deluge"
| "/docs/integrations/docker-hub"
| "/docs/integrations/docker"
| "/docs/integrations/emby"
| "/docs/integrations/github-containerregistry"
| "/docs/integrations/github"
| "/docs/integrations/gitlab"
| "/docs/integrations/home-assistant"
| "/docs/integrations/ical"
| "/docs/integrations/jellyfin"
| "/docs/integrations/jellyseerr"
| "/docs/integrations/kubernetes"
| "/docs/integrations/lidarr"
| "/docs/integrations/linux-server-io"
| "/docs/integrations/nextcloud"
| "/docs/integrations/npm"
| "/docs/integrations/ntfy"
| "/docs/integrations/nzbget"
| "/docs/integrations/open-media-vault"
| "/docs/integrations/opnsense"
| "/docs/integrations/overseerr"
| "/docs/integrations/pi-hole"
| "/docs/integrations/plex"
| "/docs/integrations/prowlarr"
| "/docs/integrations/proxmox"
| "/docs/integrations/q-bittorent"
| "/docs/integrations/quay"
| "/docs/integrations/radarr"
| "/docs/integrations/readarr"
| "/docs/integrations/sabnzbd"
| "/docs/integrations/sonarr"
| "/docs/integrations/tdarr"
| "/docs/integrations/transmission"
| "/docs/integrations/truenas"
| "/docs/integrations/unifi-controller"
| "/docs/integrations/unraid"
| "/docs/management/api"
| "/docs/management/apps"
| "/docs/management/boards"
| "/docs/management/certificates"
| "/docs/management/integrations"
| "/docs/management/media"
| "/docs/management/search-engines"
| "/docs/management/settings"
| "/docs/management/tasks"
| "/docs/management/users"
| "/docs/widgets/app"
| "/docs/widgets/bookmarks"
| "/docs/widgets/calendar"
| "/docs/widgets/clock"
| "/docs/widgets/dns-hole-controls"
| "/docs/widgets/dns-hole-summary"
| "/docs/widgets/docker-containers"
| "/docs/widgets/downloads"
| "/docs/widgets/firewall"
| "/docs/widgets/health-monitoring"
| "/docs/widgets/iframe"
| "/docs/widgets/indexer-manager"
| "/docs/widgets/media-releases"
| "/docs/widgets/media-request-list"
| "/docs/widgets/media-request-stats"
| "/docs/widgets/media-server"
| "/docs/widgets/media-transcoding"
| "/docs/widgets/minecraft-server-status"
| "/docs/widgets/network-controller-status"
| "/docs/widgets/network-controller-summary"
| "/docs/widgets/notebook"
| "/docs/widgets/notifications"
| "/docs/widgets/releases"
| "/docs/widgets/rss-feed"
| "/docs/widgets/smart-home-entity-state"
| "/docs/widgets/smart-home-execute-automation"
| "/docs/widgets/stock-price"
| "/docs/widgets/system-resources"
| "/docs/widgets/video"
| "/docs/widgets/weather"
| ""
| "/sitemap.xml";

14
packages/definitions/src/docs/index.ts Normal file
View File

@@ -0,0 +1,14 @@
import type { HomarrDocumentationPath } from "./homarr-docs-sitemap";
const documentationBaseUrl = "https://homarr.dev";
// Please use the method so the path can be checked!
export const createDocumentationLink = (
path: HomarrDocumentationPath,
hashTag?: `#${string}`,
queryParams?: Record<string, string>,
) => {
const url = `${documentationBaseUrl}${path}`;
const params = queryParams ? `?${new URLSearchParams(queryParams)}` : "";
return `${url}${params}${hashTag ?? ""}`;
};