diff --git a/de/advanced/dashboard/permissions.mdx b/de/advanced/dashboard/permissions.mdx new file mode 100644 index 000000000..86a0dd642 --- /dev/null +++ b/de/advanced/dashboard/permissions.mdx @@ -0,0 +1,16 @@ +--- +title: Editor-Berechtigungen +description: Erlauben Sie mehr Teammitgliedern, Ihre Dokumentation zu aktualisieren +--- + +Das Teammitglied, das Ihre erste Dokumentation erstellt hat, wird Aktualisierungszugriff auf Ihre Dokumentation haben, solange sie mit demselben GitHub-Konto in Ihr Dokumentations-Repository pushen, das bei der Anmeldung für Mintlify verwendet wurde. + +Wenn ein anderer Editor versucht, die Dokumentation im kostenlosen Plan zu aktualisieren, werden Sie eine Warnung in Ihrer Git-Commit-Prüfung sehen. + + + + + +In den Details der Git-Prüfungswarnung finden Sie den Link zum Upgrade Ihres Plans. Sie können Ihren Plan auch im [Dashboard](https://dashboard.mintlify.com) upgraden, um unbegrenzten Editoren das Aktualisieren Ihrer Dokumentation zu ermöglichen. Sobald Sie Ihren Plan upgraden, lösen Sie ein manuelles Update aus oder pushen Sie eine weitere Änderung, um Ihre Updates zu deployen. + +Erfahren Sie mehr über unsere Preise [hier](https://mintlify.com/pricing). diff --git a/de/advanced/dashboard/sso.mdx b/de/advanced/dashboard/sso.mdx new file mode 100644 index 000000000..47e7f8fc1 --- /dev/null +++ b/de/advanced/dashboard/sso.mdx @@ -0,0 +1,105 @@ +--- +title: Single Sign-On (SSO) +description: Passen Sie an, wie sich Ihr Team in Ihrem Admin-Dashboard anmelden kann +--- + +Nutzen Sie Single Sign-on für Ihr Dashboard über SAML und OIDC. Wenn Sie Okta oder Google Workspace verwenden, haben wir anbieterspezifische Dokumentation für die Einrichtung von SSO. Bei anderen Anbietern kontaktieren Sie uns bitte! + + + SSO-Funktionalität ist in unserem Enterprise-Plan verfügbar.[Kontaktieren + Sie uns](https://mintlify.com/enterprise) um mehr zu erfahren! + + +## Okta + + + + + + Unter `Applications`, klicken Sie, um eine neue App-Integration mit SAML 2.0 zu erstellen. + + + + Geben Sie Folgendes ein: + + * Single Sign-on URL (von Mintlify bereitgestellt) + * Audience URI (von Mintlify bereitgestellt) + * Name ID Format: `EmailAddress` + * Attributanweisungen: + | Name | Namensformat | Wert | + | ----------- | ------------ | ---------------- | + | `firstName` | Basic | `user.firstName` | + | `lastName` | Basic | `user.lastName` | + + + + Sobald die Anwendung eingerichtet ist, navigieren Sie zum Sign-on-Tab und senden Sie uns die Metadata-URL. + Wir werden die Verbindung von unserer Seite mit diesen Informationen aktivieren. + + + + + + + + Unter `Applications`, klicken Sie, um eine neue App-Integration mit OIDC zu erstellen. + Sie sollten den `Web Application` Anwendungstyp wählen. + + + + Wählen Sie den Autorisierungscode-Grant-Typ und geben Sie die von Mintlify bereitgestellte Redirect-URI ein. + + + + Sobald die Anwendung eingerichtet ist, navigieren Sie zum Allgemeinen Tab und finden Sie die Client-ID & das Client-Secret. + Bitte stellen Sie uns diese zusammen mit Ihrer Okta-Instanz-URL sicher zur Verfügung (z.B. `.okta.com`). Sie können diese über einen Dienst wie 1Password oder SendSafely senden. + + + + + +## Google Workspace + + + + + + Unter `Web and mobile apps`, wählen Sie `Add custom SAML app` aus dem `Add app` Dropdown-Menü. + + + ![](/images/gsuite-add-custom-saml-app.png) + + + + + Kopieren Sie die bereitgestellte SSO-URL, Entity ID und das x509-Zertifikat und senden Sie diese an das Mintlify-Team. + + + ![](/images/gsuite-saml-metadata.png) + + + + + Geben Sie auf der Seite für Service-Provider-Details Folgendes ein: + + * ACS URL (von Mintlify bereitgestellt) + * Entity ID (von Mintlify bereitgestellt) + * Name ID Format: `EMAIL` + * Name ID: `Basic Information > Primary email` + + + ![](/images/gsuite-sp-details.png) + + + Geben Sie auf der nächsten Seite die folgenden Attributanweisungen ein: + + | Google Verzeichnisattribut | App-Attribut | + | -------------------------- | ------------ | + | `First name` | `firstName` | + | `Last name` | `lastName` | + + Sobald dieser Schritt abgeschlossen ist und die Benutzer der Anwendung zugewiesen sind, informieren Sie unser Team und wir aktivieren SSO für Ihr Konto! + + + + diff --git a/de/advanced/mcp/generate.mdx b/de/advanced/mcp/generate.mdx new file mode 100644 index 000000000..3088f6e16 --- /dev/null +++ b/de/advanced/mcp/generate.mdx @@ -0,0 +1,42 @@ +--- +title: MCP Generator +description: Lernen Sie, wie Sie Ihren eigenen MCP Server einrichten +icon: 'text-size' +--- + + + Diese Seite widmet sich der Einrichtung Ihres eigenen MCP Servers. Wenn Sie Informationen zur Verwendung des Mintlify MCP Servers suchen, lesen Sie bitte die + [Installation und Verwendung des Mintlify MCP Servers](/advanced/mcp/quickstart) Seite. + + +## Erste Schritte + +Führen Sie `npm i @mintlify/mcp` aus, um die `@mintlify/mcp` CLI zu installieren. + +Im [Dashboard](https://dashboard.mintlify.com/products/mcp) gehen Sie zu `MCP Server`, auf dieser Seite schalten Sie um, um Ihren einzigartigen Installationsbefehl zu sehen. Dies ist der Befehl zur Installation Ihres MCP Servers mit der `@mintlify/mcp` CLI. + + + Stellen Sie sicher, dass Sie den OpenAPI-Zugriff aktivieren, damit der MCP-Server auf **alle** + Endpunkte in Ihrer OpenAPI-Spezifikation zugreifen kann. + + +## Starten Sie den MCP-Server lokal + + + + Führen Sie den folgenden Befehl aus, um den Server zu installieren: + + ```bash + npx @mintlify/mcp add [your subdomain] + ``` + + + + Wenn Ihre API einen Authentifizierungs-Token erfordert, weisen Sie Ihren Endkunden an, diesen zu besorgen und anzuwenden, wenn diese Antwort erscheint: `> What is the Authorization + (basic token)?` Andernfalls können Sie diesen Schritt überspringen. + + + + Sie können jetzt ausführen: `bash npm --prefix ~/.mcp/[your subdomain] start ` + + diff --git a/de/advanced/mcp/quickstart.mdx b/de/advanced/mcp/quickstart.mdx new file mode 100644 index 000000000..50d96ba20 --- /dev/null +++ b/de/advanced/mcp/quickstart.mdx @@ -0,0 +1,97 @@ +--- +title: Schnellstart +description: Generieren Sie einen MCP-Server, um Ihr Produkt mit LLMs zu verbinden +--- + +## Einführung + +Der MCP Generator ist ein CLI-Tool, das einen MCP-Server basierend auf der Dokumentation Ihres Unternehmens und der OpenAPI-Spezifikation, falls verfügbar, generiert. Es nimmt Ihre Dokumentation und eine OpenAPI-Spezifikation auf und gibt einen MCP-Server aus, der mit jedem MCP-Client verwendet werden kann. Der MCP Generator wird über[npm-Paket](https://www.npmjs.com/package/mcp)bereitgestellt und generiert einen MCP-Server, der mit jedem MCP-Client verwendet werden kann. + +Mintlify ermöglicht es Ihnen, einen MCP-Server zu erstellen, der es KI-Tools erlaubt, in diesen wichtigen Szenarien mit Ihren Dokumenten zu interagieren: + +1. **Docs Q\&A**, ähnlich wie unser KI-Chat. Dies ist automatisch für Ihre Dokumente aktiviert, keine Einrichtung erforderlich. +2. **Echtzeit-API-Abfragen**, wenn Sie eine OpenAPI-Spezifikation haben, gehen Sie zu den`Mintlify Dashboard > Products > MCP Server`und aktivieren Sie den Schalter für Ihre OpenAPI-Spezifikation. + + + Durch Aktivierung des OpenAPI-Schalters erlauben Sie dem MCP-Server den Zugriff auf + **alle**Endpunkte in Ihrer OpenAPI-Spezifikation. + + +## Installieren Sie den MCP-Server + + + Diese Seite ist dem Mintlify MCP-Server gewidmet. Wenn Sie Informationen zur Generierung Ihres MCP suchen, lesen Sie bitte die[MCP Generator](/advanced/mcp/generate)Seite. + + +## Beispielinstallation mit dem Mintlify MCP-Server + +Um den Mintlify MCP-Server zu verwenden, benötigen Sie einen[API-Schlüssel](https://mintlify.com/docs/advanced/rest-api/overview#authentication)von Ihrem Mintlify-Konto. Wenn Sie noch keinen haben, navigieren Sie zu`Settings > API Keys > Chat API Key`und erstellen Sie einen neuen Schlüssel. + +## Starten Sie den MCP-Server lokal + + + + Führen Sie den folgenden Befehl aus, um den Server zu installieren: + + ```bash + npx @mintlify/mcp add mintlify + ``` + + + + Die folgende Antwort wird nach Ausführung des vorherigen Befehls angezeigt: + + ``` + > What is the Authorization (basic token)? + ``` + + Kopieren Sie mit Ihrem API-Chat-Schlüssel das Authentifizierungstoken und fügen Sie es in die CLI ein. + + + + Sie können jetzt ausführen: + + ```bash + npm --prefix ~/.mcp/mintlify start + ``` + + + +## Verwenden Sie Ihren Server mit Claude + + + Laden Sie die[Claude Desktop App](https://claude.ai/download) + + +Sobald Sie die Claude Desktop App installiert haben, folgen Sie diesen Schritten: + + + + + + Fügen Sie Folgendes zu der`claude_desktop_config.json`hinzu: + + ```json + { + "mcpServers": { + "mintlify": { + "command": "npm", + "args": [ + "--prefix", + "~/.mcp/mintlify", + "start" + ] + } + } + } + ``` + + + + Wenn Sie darauf klicken, sollten Sie die verfügbaren MCP-Tools in Ihrem Server sehen. + + + ![Claude MCP](/images/mcp-with-claude.png) + + + diff --git a/de/advanced/rest-api/chat/create-topic.mdx b/de/advanced/rest-api/chat/create-topic.mdx new file mode 100644 index 000000000..dc00663e3 --- /dev/null +++ b/de/advanced/rest-api/chat/create-topic.mdx @@ -0,0 +1,3 @@ +--- +openapi: POST /chat/topic +--- diff --git a/de/advanced/rest-api/chat/generate-message.mdx b/de/advanced/rest-api/chat/generate-message.mdx new file mode 100644 index 000000000..b1cdbbb37 --- /dev/null +++ b/de/advanced/rest-api/chat/generate-message.mdx @@ -0,0 +1,3 @@ +--- +openapi: POST /chat/message +--- diff --git a/de/advanced/rest-api/overview.mdx b/de/advanced/rest-api/overview.mdx new file mode 100644 index 000000000..9c170f972 --- /dev/null +++ b/de/advanced/rest-api/overview.mdx @@ -0,0 +1,38 @@ +--- +title: Überblick +--- + +## Updates auslösen + +Sie können die REST-API nutzen, um programmatisch ein Update auszulösen, wenn gewünscht. + + + Während der Hauptanwendungsfall das Auslösen von Updates sein wird, werden wir mit der Zeit mehr und mehr + Funktionalität zur API hinzufügen. Lassen Sie uns wissen, was Sie sonst noch sehen möchten in + [unserer Community](https://mintlify.com/community)! + + +## Authentifizierung + +Sie können einen API-Schlüssel generieren über +[das Dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). Der API-Schlüssel ist mit der gesamten Organisation verbunden und kann über mehrere Deployments hinweg verwendet werden. + + + + + +## Admin-API-Schlüssel + +Der Admin-API-Schlüssel wird für die Mehrheit der API verwendet. Er wird verwendet, um Aktualisierungen über den [Update-Endpunkt](/advanced/rest-api/update/trigger). + +## Chat-API-Schlüssel + +Die Chat-API ermöglicht es Ihnen, die KI-Chat-Erfahrung, die auf Ihren Dokumenten basiert und kontinuierlich aktualisiert wird, in jede beliebige Anwendung Ihrer Wahl einzubetten. + +Die Antworten enthalten Zitate, sodass Sie Ihre Benutzer zu den richtigen Stellen führen können, an denen sie Hilfe benötigen. + + + Der Chat-API-Token ist ein öffentlicher Token, der in Ihrem Frontend-Code referenziert werden kann, während der API-Schlüssel ein serverseitiger Token ist, der geheim gehalten werden sollte. + + +Nachdem Sie nun einen API-Schlüssel haben, schauen Sie sich unser [Beispiel](https://github.com/mintlify/discovery-api-example) an, wie Sie die API für KI-Chat verwenden können. Sie können auch eine bereitgestellte Version dieses Beispiels unter [chat.mintlify.com](https://chat.mintlify.com) sehen. diff --git a/de/advanced/rest-api/update/status.mdx b/de/advanced/rest-api/update/status.mdx new file mode 100644 index 000000000..0bc6efc18 --- /dev/null +++ b/de/advanced/rest-api/update/status.mdx @@ -0,0 +1,3 @@ +--- +openapi: GET /project/update-status/{statusId} +--- diff --git a/de/advanced/rest-api/update/trigger.mdx b/de/advanced/rest-api/update/trigger.mdx new file mode 100644 index 000000000..8d47fe1e6 --- /dev/null +++ b/de/advanced/rest-api/update/trigger.mdx @@ -0,0 +1,3 @@ +--- +openapi: POST /project/update/{projectId} +--- diff --git a/de/advanced/subpath/cloudflare.mdx b/de/advanced/subpath/cloudflare.mdx new file mode 100644 index 000000000..805341999 --- /dev/null +++ b/de/advanced/subpath/cloudflare.mdx @@ -0,0 +1,75 @@ +--- +title: Cloudflare +description: Hosten Sie Dokumentation unter einem /docs Unterpfad mit Cloudflare Workers +--- + +## Cloudflare Worker erstellen + +Navigieren Sie zu `Workers & Pages > Create application > Create worker`. Sie sollten den folgenden Bildschirm sehen, wo Sie einen neuen Cloudflare Worker erstellen können. + + + Create a Cloudflare worker + + + + Beachten Sie: Wenn Cloudflare Ihr DNS-Provider ist, sollten Sie kein Proxying für den CNAME-Eintrag verwenden + + +### Benutzerdefinierte Domain hinzufügen + +Sobald der Worker erstellt ist, klicken Sie auf `Configure worker`. Navigieren Sie zum Worker +`Settings > Triggers`. Klicken Sie auf `Add Custom Domain`, um Ihre gewünschte Domain zur Liste hinzuzufügen - wir empfehlen, sowohl die Version mit als auch ohne `www.` +vor der Domain hinzuzufügen. + + + Cloudflare worker custom domain + + +Wenn Sie Probleme beim Einrichten eines benutzerdefinierten Unterverzeichnisses haben, +[kontaktieren Sie unser Support-Team](mailto:sales@mintlify.com) und wir führen Sie durch den Prozess, Ihr Hosting bei uns zu aktualisieren. + +### Worker-Skript bearbeiten + +Klicken Sie auf `Edit Code` und fügen Sie das folgende Skript in den Code des Workers ein. + + + Cloudflare edit code + + + + Bearbeiten Sie `DOCS_URL` indem Sie `[SUBDOMAIN]` durch Ihre eindeutige Subdomain ersetzen und`CUSTOM_URL` durch die Basis-URL Ihrer Website. + + +```javascript +addEventListener("fetch", (event) => { + event.respondWith(handleRequest(event.request)); +}); + +async function handleRequest(request) { + try { + const urlObject = new URL(request.url); + // If the request is to the docs subdirectory + if (/^\/docs/.test(urlObject.pathname)) { + // Then Proxy to Mintlify + const DOCS_URL = "[SUBDOMAIN].mintlify.dev"; + const CUSTOM_URL = "[YOUR_DOMAIN]"; + + let url = new URL(request.url); + url.hostname = DOCS_URL; + + let proxyRequest = new Request(url, request); + + proxyRequest.headers.set("Host", DOCS_URL); + proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL); + proxyRequest.headers.set("X-Forwarded-Proto", "https"); + + return await fetch(proxyRequest); + } + } catch (error) { + // if no action found, play the regular request + return await fetch(request); + } +} +``` + +Klicken Sie auf `Deploy` und warten Sie, bis die Änderungen übernommen wurden (dies kann bis zu einige Stunden dauern). diff --git a/de/advanced/subpath/route53-cloudfront.mdx b/de/advanced/subpath/route53-cloudfront.mdx new file mode 100644 index 000000000..bef58a4c6 --- /dev/null +++ b/de/advanced/subpath/route53-cloudfront.mdx @@ -0,0 +1,136 @@ +--- +title: AWS Route 53 und Cloudfront +sidebarTitle: AWS +description: Dokumentation in einem /docs Unterverzeichnis mit AWS-Diensten hosten +--- + +## Cloudfront-Distribution erstellen + +Navigieren Sie zu [Cloudfront](https://aws.amazon.com/cloudfront) in der AWS-Konsole und klicken Sie auf `Create distribution` + + + ![Cloudfront Create Distribution](/images/cloudfront/create-distribution.png) + + +Geben Sie für die Ursprungsdomäne `[SUBDOMAIN].mintlify.dev` ein, wobei `[SUBDOMAIN]` ist die eindeutige Subdomain des Projekts. Klicken Sie auf `Use: [SUBDOMAIN].mintlify.dev` + +![Cloudfront Origin name](/images/cloudfront/origin-name.png) + +Für **Cache-Schlüssel und Ursprungsanfragen**, wählen Sie `Caching Optimized`. + + + ![Cloudfront Caching policy](/images/cloudfront/caching-policy.png) + + +Und für **Web Application Firewall (WAF)**, aktivieren Sie Sicherheitsschutz + + + ![Cloudfront Caching + policy](/images/cloudfront/enable-security-protections.png) + + +Die übrigen Einstellungen sollten standardmäßig sein. Klicken Sie `Create distribution`. + +## Standardursprung hinzufügen + +Nach dem Erstellen der Distribution navigieren Sie zum `Origins` Tab. + +![Cloudfront Origins](/images/cloudfront/origins.png) + +Wir möchten eine Staging-URL finden, die die Hauptdomain (example.com) spiegelt. Dies ist stark abhängig davon, wie Ihre Landing Page gehostet wird. + + + Wenn Ihre Landing Page zum Beispiel auf Webflow gehostet wird, können Sie die Webflow-Staging-URL verwenden. Sie würde aussehen wie `.webflow.io`. + + Wenn Sie Vercel verwenden, nutzen Sie die `.vercel.app` Domain, die für jedes Projekt verfügbar ist. + + + + Wenn Sie sich nicht sicher sind, wie Sie eine Staging-URL für Ihre Landing Page erhalten, [kontaktieren Sie den Support](mailto:support@mintlify.com) und wir helfen Ihnen gerne + + +Sobald Sie die Staging-URL haben, unsere ist zum Beispiel [mintlify-landing-page.vercel.app](https://mintlify-landing-page.vercel.app), erstellen Sie einen neuen Ursprung und fügen Sie ihn als **Ursprungsdomain**. + + + ![Cloudfront Default Origins](/images/cloudfront/default-origin.png) + + +Zu diesem Zeitpunkt sollten Sie zwei Ursprünge haben - einen mit `[SUBDOMAIN].mintlify.app` und einen anderen mit der Staging-URL. + +## Verhalten festlegen + +Verhaltensweisen in Cloudfront ermöglichen die Kontrolle über die Subpath-Logik. Auf hoher Ebene wollen wir die folgende Logik erstellen. + +* **Wenn ein Benutzer auf /docs landet**, gehe zu `[SUBDOMAIN].mintlify.dev` +* **Wenn ein Benutzer auf eine andere Seite landet**, gehe zur aktuellen Landing Page + +Wir werden drei Verhaltensweisen erstellen, indem wir auf die `Create behavior` Schaltfläche klicken. + +### `/docs/*` + +Das erste Verhalten sollte ein **Pfadmuster** von `/docs/*` mit **Ursprung und Ursprungsgruppen** die auf die `.mintlify.dev` URL verweisen (in unserem Fall `acme.mintlify.dev`) + +![Cloudfront Behavior 1](/images/cloudfront/behavior-1.png) + +Für **Cache-Richtlinie**, wählen Sie `CachingOptimized` und erstellen Sie das Verhalten. + +### `/docs` + +Das zweite Verhalten sollte dasselbe sein wie das erste, aber mit einem **Pfadmuster** von `/docs` und **Ursprung und Ursprungsgruppen** die auf dieselbe `.mintlify.dev` URL verweisen. + +![Cloudfront Behavior 2](/images/cloudfront/behavior-2.png) + +### `Default (*)` + +Zuletzt werden wir das `Default (*)` Verhalten bearbeiten. + + + ![Cloudfront Behavior Default 1](/images/cloudfront/default-behavior-1.png) + + +Wir werden beim Standardverhalten die **Ursprung und Ursprungsgruppen** auf die Staging-URL ändern (in unserem Fall `mintlify-landing-page.vercel.app`). + + + ![Cloudfront Behavior Default 2](/images/cloudfront/default-behavior-2.png) + + +Klicken Sie auf `Save changes`. + +## Distribution Vorschau + +Sie können nun testen, ob Ihre Distribution richtig eingerichtet ist, indem Sie zum `General` Tab gehen und die **Distributions-Domainname** URL besuchen. + + + ![Cloudfront Preview + distribution](/images/cloudfront/preview-distribution.png) + + +Alle Seiten sollten auf Ihre Hauptlandingpage weiterleiten, aber wenn Sie `/docs` an die URL anhängen, sollten Sie sehen, dass es zur Mintlify Dokumentationsinstanz weiterleitet. + +## Verbindung mit Route53 + +Jetzt werden wir die Funktionalität der Cloudfront-Distribution in Ihre primäre Domain einbinden. + + + Für diesen Abschnitt können Sie auch AWS's offiziellen Leitfaden zur [Konfiguration von Amazon Route 53 zur Weiterleitung von Traffic an eine CloudFront-Distribution](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html#routing-to-cloudfront-distribution-config) + + +Navigieren Sie zu [Route53](https://aws.amazon.com/route53) in der AWS-Konsole und klicken Sie auf `Hosted zone` für Ihre primäre Domain. Klicken Sie auf `Create record` + + + ![Route 53 create record](/images/cloudfront/route53-create-record.png) + + +Aktivieren Sie `Alias` und dann **Traffic weiterleiten an** die `Alias to CloudFront distribution` Option. + + + ![Route 53 create record alias](/images/cloudfront/create-record-alias.png) + + +Klicken Sie `Create records`. + + + Möglicherweise müssen Sie den bestehenden A-Eintrag entfernen, falls einer vorhanden ist. + + +Und voilà! Ihre Dokumentation sollte nun unter `/docs` für Ihre primäre Domain erreichbar sein. diff --git a/de/advanced/subpath/vercel.mdx b/de/advanced/subpath/vercel.mdx new file mode 100644 index 000000000..ec165f485 --- /dev/null +++ b/de/advanced/subpath/vercel.mdx @@ -0,0 +1,30 @@ +--- +title: Vercel +description: Dokumentation unter einem /docs Unterpfad mit Vercel hosten +--- + +## vercel.json Konfiguration + +Um Ihre Dokumentation unter einem benutzerdefinierten Unterpfad mit Vercel zu hosten, müssen Sie die +folgende Konfiguration zu Ihrer `vercel.json` Datei hinzufügen. + +```json +{ + "rewrites": [ + { + "source": "/docs", + "destination": "https://[subdomain].mintlify.dev/docs" + }, + { + "source": "/docs/:match*", + "destination": "https://[subdomain].mintlify.dev/docs/:match*" + } + ] +} +``` + + + Für weitere Informationen können Sie auch Vercels offiziellen Leitfaden zu + Rewrites konsultieren: [Projektkonfiguration: + Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites) + diff --git a/de/api-playground/mdx/authentication.mdx b/de/api-playground/mdx/authentication.mdx new file mode 100644 index 000000000..ee4d39526 --- /dev/null +++ b/de/api-playground/mdx/authentication.mdx @@ -0,0 +1,87 @@ +--- +title: Authentication +description: Sie können Authentifizierungsparameter festlegen, damit Benutzer ihre echten API-Schlüssel verwenden können. +--- + +## Authentifizierung aktivieren + +Sie können eine Authentifizierungsmethode zu Ihrer docs.json hinzufügen, um sie auf jeder Seite zu aktivieren, oder Sie können sie seitenweise festlegen. + +Die Authentifizierungsmethode der Seite überschreibt docs.json, wenn beide gesetzt sind. + +### Bearer Token + + + ```json docs.json + "api": { + "mdx": { + "auth": { + "method": "bearer" + } + } + } + ``` + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "bearer" + --- + ``` + + +### Basis-Authentifizierung + + + ```json docs.json + "api": { + "mdx": { + "auth": { + "method": "basic" + } + } + } + ``` + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "basic" + --- + ``` + + +### API-Schlüssel + + + ```json docs.json + "api": { + "mdx": { + "auth": { + "method": "key", + "name": "x-api-key" + } + } + } + ``` + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "key" + --- + ``` + + +### Keine + +Die "keine" Authentifizierungsmethode ist nützlich, um die Authentifizierung für einen bestimmten Endpunkt zu deaktivieren, nachdem in docs.json ein Standard festgelegt wurde. + + + ```md Page Metadata + --- + title: "Your page title" + authMethod: "none" + --- + ``` + diff --git a/de/api-playground/mdx/configuration.mdx b/de/api-playground/mdx/configuration.mdx new file mode 100644 index 000000000..c60e9f240 --- /dev/null +++ b/de/api-playground/mdx/configuration.mdx @@ -0,0 +1,70 @@ +--- +title: MDX Setup +description: Generieren Sie Dokumentationsseiten für Ihre API-Endpunkte mit MDX +--- + +Mintlify ermöglicht es Ihnen, Ihre API-Endpunkte mithilfe einer Kombination aus`docs.json` Konfiguration, MDX-Metadatenfeldern und der`` Komponente zu definieren. Aus den definierten Endpunkten generieren wir einen API-Playground, Anforderungsbeispiele und Antwortbeispiele. + + + + In Ihrer`docs.json` Datei definieren Sie Ihre Basis-URL und Authentifizierungsmethode: + + ```json + "api": { + "mdx": { + "server": "https://mintlify.com/api", // string array for multiple base URLs + "auth": { + "method": "key", + "name": "x-api-key" // options: bearer, basic, key. + } + } + } + ``` + + Wenn Sie keinen API-Playground anzeigen möchten, müssen Sie keine Authentifizierungstypen angeben. Verbergen Sie den Playground mit dem folgenden Feld: + + ```json + "api": { + "playground": { + "display": "none" + } + } + ``` + + Eine vollständige Liste der API-Konfigurationen finden Sie[hier](/settings/global#param-api). + + + + Jede API-Endpunkt-Seite sollte eine entsprechende MDX-Datei haben. Definieren Sie am Anfang jeder Datei: + + ```md + --- + title: 'Create new user' + api: 'POST https://api.mintlify.com/user' + --- + ``` + + Sie können Pfadparameter angeben, indem Sie den Parameternamen zum Pfad hinzufügen, eingeschlossen in`{}`: + + ```bash + https://api.example.com/v1/endpoint/{userId} + ``` + + + Wenn Sie`server` konfiguriert in[docs.json](/settings/global) haben, können Sie relative Pfade wie`/v1/endpoint`. + + + Sie können auch den global definierten Anzeigemodus für den API-Playground pro Seite überschreiben, indem Sie`playground` am Anfang der MDX-Datei: + + ```md + --- + title: 'Create new user' + api: 'POST https://api.mintlify.com/user' + playground: 'none' + ``` + + + + Fügen Sie Ihre Endpunkt-Seiten zur Seitenleiste hinzu, indem Sie die Pfade zum `navigation` Feld in Ihrer `docs.json`. Erfahren Sie mehr über die Strukturierung Ihrer Dokumentation [hier](/settings/navigation). + + diff --git a/de/api-playground/openapi/advanced-features.mdx b/de/api-playground/openapi/advanced-features.mdx new file mode 100644 index 000000000..e31edf615 --- /dev/null +++ b/de/api-playground/openapi/advanced-features.mdx @@ -0,0 +1,139 @@ +--- +title: Erweiterte Funktionen +description: Unterstützung für erweiterte OpenAPI-Funktionen +--- + +OpenAPI 3 verfügt über einige erweiterte Funktionen zur Beschreibung komplexer APIs. Hier erfahren Sie, wie Sie diese mit Mintlify verwenden können. + +## `oneOf`, `anyOf`, `allOf` + +Für komplexe Datentypen bietet OpenAPI die `oneOf`, `anyOf`, und `allOf` Schlüsselwörter, mit denen Sie Schemas auf bestimmte Weise kombinieren können. Mehr über diese Schlüsselwörter können Sie in der [Swagger-Dokumentation](https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/) nachlesen, aber im Wesentlichen: + +* `oneOf` funktioniert wie ein "exklusives Oder"-Operator +* `anyOf` funktioniert wie ein "Oder"-Operator +* `allOf` funktioniert wie ein "Und"-Operator + +Die `oneOf` und `anyOf` Schlüsselwörter werden gleich behandelt. Wir haben festgestellt, dass wenn Menschen `oneOf` verwenden, sie oft *meinen* `anyOf` - und es gibt oft keinen bedeutenden Unterschied für den Benutzer. + +Das `not` Schlüsselwort wird derzeit nicht unterstützt. + +### Schemas kombinieren mit `allOf` + +Mintlify führt eine Vorverarbeitung Ihres OpenAPI-Dokuments durch, um diese komplexen Kombinationen lesbar darzustellen. Wenn Sie zum Beispiel zwei Objekt-Schemas mit `allOf` kombinieren, fasst Mintlify die Eigenschaften beider in einem einzigen Objekt zusammen. Dies wird besonders nützlich bei der Nutzung von [OpenAPIs wiederverwendbaren `components`](https://swagger.io/docs/specification/components/). + +```yaml +org_with_users: + allOf: + - $ref: '#/components/schemas/Org' + - type: object + properties: + users: + type: array + description: An array containing all users in the organization +... +components: + schemas: + Org: + type: object + properties: + id: + type: string + description: The ID of the organization +``` + + + + + Die ID der Organisation + + + + Ein Array mit allen Benutzern in der Organisation + + + + +### Optionen bereitstellen mit `oneOf` und `anyOf` + +Wenn Sie `oneOf` oder `anyOf` verwenden, zeigt Mintlify die Optionen in einem Tab-Container an. Um Ihren Optionen hilfreiche Namen zu geben, stellen Sie sicher, dass jedes Unterschema ein `title` Feld hat. Hier ist zum Beispiel, wie Sie zwei verschiedene Arten von Lieferadressen anzeigen könnten: + +```yaml +delivery_address: + oneOf: + - title: StreetAddress + type: object + properties: + address_line_1: + type: string + description: The street address of the recipient + ... + - title: POBox + type: object + properties: + box_number: + type: string + description: The number of the PO Box + ... +``` + + +
+ + + + Die Straßenadresse des Wohnsitzes + + + + + + Die Nummer des Postfachs + + + +
+ + +## `x-codeSamples` + +Wenn Ihre Benutzer mit Ihrer API über ein SDK anstatt direkt über eine Netzwerkanfrage interagieren, können Sie Codebeispiele zu Ihrem OpenAPI-Dokument hinzufügen, und Mintlify wird diese in Ihren OpenAPI-Seiten anzeigen. Sie können Ihre Codebeispiele mit der `x-codeSamples` Erweiterung definieren. Diese Eigenschaft kann innerhalb jeder Anfragemethode hinzugefügt werden und hat das folgende Schema: + + + Die Programmiersprache des Codebeispiels. + + + + Die Bezeichnung für das Beispiel. Dies ist nützlich, wenn mehrere Beispiele für einen einzelnen Endpunkt bereitgestellt werden. + + + + Der Quellcode des Beispiels. + + +Hier ist ein Beispiel einiger Codebeispiele für eine Pflanzenverfolgungsapp, die sowohl ein Bash-CLI-Tool als auch ein JavaScript-SDK hat. + +```yaml +paths: + /plants: + get: + ... + x-codeSamples: + - lang: bash + label: List all unwatered plants + source: | + planter list -u + - lang: javascript + label: List all unwatered plants + source: | + const planter = require('planter'); + planter.list({ unwatered: true }); + - lang: bash + label: List all potted plants + source: | + planter list -p + - lang: javascript + label: List all potted plants + source: | + const planter = require('planter'); + planter.list({ potted: true }); +``` diff --git a/de/api-playground/openapi/setup.mdx b/de/api-playground/openapi/setup.mdx new file mode 100644 index 000000000..cbbda2679 --- /dev/null +++ b/de/api-playground/openapi/setup.mdx @@ -0,0 +1,149 @@ +--- +title: OpenAPI Setup +description: Referenzieren Sie OpenAPI-Endpunkte in Ihren Dokumentationsseiten +--- + +## Eine OpenAPI-Spezifikationsdatei hinzufügen + +Um Ihre Endpunkte mit OpenAPI zu beschreiben, stellen Sie sicher, dass Sie ein gültiges OpenAPI- +Dokument im JSON- oder YAML-Format haben, das der[OpenAPI-Spezifikation](https://swagger.io/specification/) folgt. Ihr Dokument muss +der OpenAPI-Spezifikation 3.0+ entsprechen. +Um Ihre OpenAPI-Spezifikation zu validieren, verwenden Sie unsere [CLI](https://www.npmjs.com/package/mintlify) und führen Sie diesen Befehl aus:
`mintlify openapi-check ` + +## API-Seiten automatisch generieren + +Der schnellste Weg, mit OpenAPI zu beginnen, ist das Hinzufügen eines `openapi` Feldes zu einem Tab in der `docs.json`. Dieses Feld kann entweder den Pfad zu einem OpenAPI-Dokument in Ihrem Docs-Repository oder die URL eines gehosteten OpenAPI-Dokuments enthalten. Mintlify wird automatisch eine Seite für jede OpenAPI-Operation generieren und sie im Tab platzieren. + +**Beispiel mit Tabs:** + +```json {5} +"navigation": { + "tabs": [ + { + "tab": "API Reference", + "openapi": "https://petstore3.swagger.io/api/v3/openapi.json" + } + ] +} +``` + +![](/images/autogeneration-with-tabs.png) + +**Beispiel mit Gruppen:** + +```json {8-11} +"navigation": { + "tabs": [ + { + "tab": "API Reference", + "groups": [ + { + "group": "Endpoints", + "openapi": { + "source": "/path/to/openapi-1.json", + "directory": "api-reference" + } + } + ] + } + ] +} +``` + +Das Verzeichnisfeld ist optional. Wenn nicht angegeben, werden die Dateien im **api-reference** Ordner des Docs-Repositorys abgelegt. + +Bei Verwendung dieser Option haben die Metadaten für die generierten Seiten folgende Standardwerte: + +* `title`: Das `summary` Feld aus der OpenAPI-Operation, falls vorhanden. Andernfalls ein aus der HTTP-Methode und dem Endpunkt generierter Titel. + +* `description`: Das `description` Feld aus der OpenAPI-Operation, falls vorhanden. + +* `version`: Der `version` Wert aus dem Anker oder Tab, falls vorhanden. + +Es gibt Szenarien, in denen das Standardverhalten nicht ausreicht. Wenn Sie mehr Anpassungsmöglichkeiten benötigen, können Sie eine MDX-Seite für Ihre OpenAPI-Operation erstellen und sie wie jede andere MDX-Seite modifizieren. + +## MDX-Dateien für API-Seiten erstellen + +Wenn Sie die Seiten-Metadaten anpassen, zusätzliche Inhalte hinzufügen, bestimmte OpenAPI-Operationen auslassen oder OpenAPI-Seiten in Ihrer Navigation neu ordnen möchten, benötigen Sie eine MDX-Seite für jede Operation. Hier ist [ein Beispiel einer MDX OpenAPI-Seite](https://github.com/mindsdb/mindsdb/blob/main/docs/rest/databases/create-databases.mdx) von [MindsDB](https://docs.mindsdb.com/rest/databases/create-databases). + +![](/images/mindsdb.png) + +### Dateien manuell angeben + +Sie können jederzeit eine MDX-Seite manuell erstellen und in den Metadaten der Seite mit dem `openapi` Feld auf die OpenAPI-Operation verweisen. + + + +Durch die Verwendung der OpenAPI-Referenz werden Name, Beschreibung, Parameter, Antworten und der API-Playground automatisch aus dem OpenAPI-Dokument generiert. + +Wenn Sie mehrere OpenAPI-Dateien haben, geben Sie den Pfad zur OpenAPI-Datei an, um sicherzustellen, dass Mintlify das richtige OpenAPI-Dokument findet. Dies ist nicht erforderlich, wenn Sie nur eine OpenAPI-Datei haben - sie wird automatisch erkannt. + +Wenn Sie mit dieser Methode eine externe OpenAPI-Datei referenzieren möchten, geben Sie die URL der Datei in der docs.json an. Siehe [hier](https://mintlify.com/docs/settings/global#param-source-4) für das korrekte Format. + + + ```md Example + --- + title: "Get users" + openapi: "/path/to/openapi-1.json GET /users" + --- + ``` + + ```md Format + --- + title: "title of the page" + openapi: openapi-file-path method path + --- + ``` + + + + In den meisten Fällen müssen Methode und Pfad exakt mit der im OpenAPI-Dokument angegebenen Methode und Pfad übereinstimmen. Wenn der Endpunkt nicht in der OpenAPI-Datei existiert, wird die Seite leer sein. + + Bei Webhooks ersetzen Sie die Methode (z.B. "POST") durch "webhook" (Groß-/Kleinschreibung egal) und die korrekte Methode wird generiert. + + +### Dateien automatisch generieren + +Für große OpenAPI-Dokumente kann es viel Arbeit sein, für jede OpenAPI-Operation eine MDX-Seite zu erstellen. Um dies zu erleichtern, haben wir einen lokalen OpenAPI-Seiten-Scraper erstellt. + +Unser Mintlify [Scraper](https://www.npmjs.com/package/@mintlify/scraping) +generiert automatisch MDX-Dateien für Ihre OpenAPI-Endpunkte. + +Jede generierte Seite entspricht einer OpenAPI-Operation im "paths"-Abschnitt des OpenAPI-Schemas. Wenn Ihr OpenAPI-Dokument Version 3.1+ ist, generiert der Scraper auch Seiten für Webhooks im "webhooks"-Abschnitt des OpenAPI-Schemas. + +```bash +npx @mintlify/scraping@latest openapi-file +``` + +Fügen Sie das `-o` Flag hinzu, um einen Ordner anzugeben, in den die Dateien eingefügt werden sollen. Wenn kein Ordner angegeben wird, werden die Dateien im Arbeitsverzeichnis abgelegt. + +```bash +npx @mintlify/scraping@latest openapi-file -o api-reference +``` + +Erfahren Sie mehr über unser Scraping-Paket [hier](https://www.npmjs.com/package/@mintlify/scraping). + +Der Scraper gibt ein Array von +[Navigationseinträgen](/settings/global#structure) aus, die Ihre OpenAPI MDX-Dateien enthalten. Sie können diese Einträge entweder zu Ihrer bestehenden Navigation hinzufügen oder die Dateien manuell neu ordnen und zur Navigation hinzufügen. + + + Wenn Ihr OpenAPI-Dokument ungültig ist, werden die Dateien nicht automatisch generiert. + + +## MDX-Dateien für OpenAPI-Schemas erstellen + +Mintlify ermöglicht es Ihnen auch, einzelne Seiten für jedes OpenAPI-Schema zu erstellen, das im `components.schemas` Feld eines OpenAPI-Dokuments definiert ist: + + + ```md Example + --- + openapi-schema: OrderItem + --- + ``` + + ```md Format + --- + openapi-schema: "schema-key" + --- + ``` + diff --git a/de/api-playground/openapi/writing-openapi.mdx b/de/api-playground/openapi/writing-openapi.mdx new file mode 100644 index 000000000..05f363df3 --- /dev/null +++ b/de/api-playground/openapi/writing-openapi.mdx @@ -0,0 +1,33 @@ +--- +title: OpenAPI schreiben +description: Verwenden Sie OpenAPI-Funktionen zur Verbesserung Ihrer Dokumentation +--- + +## Beschreibung Ihrer API + +Es gibt viele großartige Online-Tools zum Lernen und Erstellen von OpenAPI-Dokumenten. Hier sind unsere Favoriten: + +* [Swagger's OpenAPI Guide](https://swagger.io/docs/specification/about/) um sich mit der OpenAPI-Syntax vertraut zu machen +* [OpenAPI v3.1.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) für alle Details über die neueste OpenAPI-Spezifikation +* [Swagger & OpenAPI Validator](https://editor.swagger.io/) zum Debuggen Ihres OpenAPI-Dokuments +* [Swagger's Editor](https://editor.swagger.io/) um Beispiele in Aktion zu sehen + + + Swagger's OpenAPI Guide ist für OpenAPI v3.0, aber fast alle Informationen sind auch auf v3.1 anwendbar. Für mehr Informationen zu den Unterschieden zwischen v3.0 und v3.1, lesen Sie [OpenAPI's Blog-Beitrag](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). + + +## Angabe der URL für Ihre API + +In einem OpenAPI-Dokument werden verschiedene API-Endpunkte durch ihre Pfade angegeben, wie `/users/{id}`, oder einfach `/`. Um die Basis-URL anzugeben, an die diese Pfade angehängt werden sollen, bietet OpenAPI das `servers` Feld. Dieses Feld ist notwendig, um einige Mintlify-Funktionen wie den API-Playground zu nutzen. Lesen Sie, wie Sie das `servers` Feld in der [Swagger-Dokumentation](https://swagger.io/docs/specification/api-host-and-base-path/) konfigurieren. + +Der API-Playground wird diese Server-URLs verwenden, um zu bestimmen, wohin Anfragen gesendet werden sollen. Wenn mehrere Server angegeben sind, erscheint ein Dropdown-Menü zum Umschalten zwischen den Servern. Wenn kein Server angegeben ist, wird der API-Playground den einfachen Modus verwenden, da es keine Möglichkeit gibt, eine Anfrage zu senden. + +Wenn verschiedene Endpunkte innerhalb Ihrer API unter verschiedenen URLs existieren, können Sie [das Serverfeld überschreiben](https://swagger.io/docs/specification/api-host-and-base-path/#:~:text=%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%C2%A0%20%2D%20southeastasia-,Overriding%20Servers,-The%20global%20servers) für einen bestimmten Pfad oder eine Operation. + +## Authentifizierung spezifizieren + +Fast alle APIs erfordern eine Methode zur Authentifizierung. OpenAPI bietet das `securitySchemes` Feld zur Definition der Authentifizierungsmethoden, die in Ihrer API verwendet werden, mit einfacher Konfiguration für die häufigsten Authentifizierungstypen - [Basic](https://swagger.io/docs/specification/authentication/basic-authentication/), [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/), und [API Keys](https://swagger.io/docs/specification/authentication/api-keys/). Um diese Authentifizierungsmethoden auf Ihre Endpunkte anzuwenden, verwendet OpenAPI das `security` Feld. Die Syntax für die Definition und Anwendung der Authentifizierung ist etwas unintuiv, also schauen Sie sich unbedingt [Swaggers Dokumentation und Beispiele](https://swagger.io/docs/specification/authentication/) zu diesem Thema an. + +Die API-Beschreibungen und der API-Playground fügen Authentifizierungsfelder basierend auf den Sicherheitskonfigurationen in Ihrem OpenAPI-Dokument hinzu. + +Wenn verschiedene Endpunkte innerhalb Ihrer API unterschiedliche Authentifizierungsmethoden erfordern, können Sie [das Sicherheitsfeld überschreiben](https://swagger.io/docs/specification/authentication/#:~:text=you%20can%20apply%20them%20to%20the%20whole%20API%20or%20individual%20operations%20by%20adding%20the%20security%20section%20on%20the%20root%20level%20or%20operation%20level%2C%20respectively.) für eine bestimmte Operation. diff --git a/de/api-playground/overview.mdx b/de/api-playground/overview.mdx new file mode 100644 index 000000000..6407502ea --- /dev/null +++ b/de/api-playground/overview.mdx @@ -0,0 +1,13 @@ +--- +title: Playground +description: Ermöglichen Sie Benutzern die Interaktion mit Ihrer API +openapi: POST /project/update/{projectId} +hideApiMarker: true +icon: play +--- + +Der API-Playground ist eine interaktive Umgebung, um Anfragen zu stellen und einen API-Endpunkt zu testen. + + + Das automatische Generieren von API-Seiten mit OpenAPI wird automatisch einen API-Playground erstellen. Lesen Sie mehr über die Verwendung von OpenAPI[hier](/api-playground/openapi). + diff --git a/de/api-playground/troubleshooting.mdx b/de/api-playground/troubleshooting.mdx new file mode 100644 index 000000000..62e767047 --- /dev/null +++ b/de/api-playground/troubleshooting.mdx @@ -0,0 +1,72 @@ +--- +title: Fehlerbehebung +description: Häufige Probleme mit API-Referenzen +icon: triangle-exclamation +--- + +API-Seiten sind komplex. Infolgedessen gibt es viele Dinge, die schief gehen können. +Hier ist eine Liste häufiger Probleme, auf die unsere Kunden gestoßen sind: + + + + In diesem Fall ist es wahrscheinlich, dass Mintlify entweder Ihr OpenAPI-Dokument nicht finden kann, + oder Ihr OpenAPI-Dokument ungültig ist. + + Das Ausführen von `mintlify dev` lokal sollte einige dieser Probleme aufdecken. + + Um zu überprüfen, ob Ihr OpenAPI-Dokument die Validierung besteht: + + 1. Besuchen Sie [diesen Validator](https://editor.swagger.io/) + 2. Wechseln Sie zum Tab "Validate text" + 3. Fügen Sie Ihr OpenAPI-Dokument ein + 4. Klicken Sie auf "Validate it!" + + Wenn das Textfeld, das unten erscheint, einen grünen Rahmen hat, hat Ihr Dokument die Validierung bestanden. + Dies ist das exakte Validierungspaket, das Mintlify zur Validierung von OpenAPI-Dokumenten verwendet. Wenn Ihr Dokument + hier die Validierung besteht, besteht eine große Chance, dass das Problem woanders liegt. + + Zusätzlich unterstützt Mintlify OpenAPI 2.0 nicht. Wenn Ihr Dokument diese Version der Spezifikation verwendet, + könnten Sie auf dieses Problem stoßen. Sie können Ihr Dokument konvertieren auf [editor.swagger.io](https://editor.swagger.io/) (unter Edit > Convert to OpenAPI 3): + + + + + + + + Dies wird normalerweise durch ein falsch geschriebenes`openapi`Feld in den Seiten-Metadaten verursacht. Stellen Sie sicher, dass die HTTP-Methode und der Pfad exakt mit der HTTP-Methode und dem Pfad im OpenAPI-Dokument übereinstimmen. + + Hier ist ein Beispiel, wie es schief gehen könnte: + + ```md get-user.mdx + --- + openapi: "GET /users/{id}/" + --- + ``` + + ```yaml openapi.yaml + paths: + "/users/{id}": + get: ... + ``` + + Beachten Sie, dass der Pfad im`openapi`Feld einen abschließenden Schrägstrich hat, während der Pfad im OpenAPI-Dokument keinen hat. + + Ein weiteres häufiges Problem ist ein falsch geschriebener Dateiname. Wenn Sie ein bestimmtes OpenAPI-Dokument im`openapi`Feld angeben, stellen Sie sicher, dass der Dateiname korrekt ist. Wenn Sie zum Beispiel zwei OpenAPI-Dokumente haben`openapi/v1.json`und`openapi/v2.json`, könnten Ihre Metadaten so aussehen: + + ```md api-reference/v1/users/get-user.mdx + --- + openapi: "v1 GET /users/{id}" + --- + ``` + + + + Wenn Sie eine benutzerdefinierte Domain konfiguriert haben, könnte dies ein Problem mit Ihrem Reverse Proxy sein. Standardmäßig beginnen Anfragen über den API Playground mit einer`POST`Anfrage an den + `/api/request`Pfad auf der Docs-Seite. Wenn Ihr Reverse Proxy so konfiguriert ist, dass er nur`GET` + Anfragen zulässt, werden all diese Anfragen fehlschlagen. Um dies zu beheben, konfigurieren Sie Ihren Reverse Proxy so, dass er`POST`Anfragen an den`/api/request`Pfad zulässt. + + Alternativ, wenn Ihr Reverse Proxy keine`POST`Anfragen zulässt, können Sie Mintlify so konfigurieren, dass Anfragen direkt an Ihr Backend gesendet werden mit der`api.playground.disableProxy` + Einstellung in der`docs.json`, wie[hier](/settings/global#api-configurations)beschrieben. Dies wird wahrscheinlich erfordern, dass Sie CORS auf Ihrem Server konfigurieren, da diese Anfragen nun direkt von den Browsern Ihrer Benutzer kommen werden. + + diff --git a/de/changelog/overview.mdx b/de/changelog/overview.mdx new file mode 100644 index 000000000..3c307c38e --- /dev/null +++ b/de/changelog/overview.mdx @@ -0,0 +1,392 @@ +--- +title: Produkt-Updates +description: Neue Updates und Verbesserungen +mode: center +--- + + + ## MCP Server-Generator + + Generieren Sie MCP-Server, damit KI-Anwendungen mit Ihren Dokumenten oder APIs interagieren können. Geschriebene Inhalte werden automatisch als MCP-Server generiert, und Sie können mit einem Klick einen MCP-Server aus Ihrer OpenAPI-Spezifikation generieren. + Schauen Sie sich die [Dokumentation zum Einstieg in MCP an.](/advanced/mcp/quickstart.mdx) + + ## mcpt: ein Register für MCP-Server + + Entdecken Sie über 105+ MCP-Server auf [mcpt](https://www.mcpt.com). Dieses Verzeichnis enthält sowohl offizielle Server als auch Server aus unserer eigenen Kundenbasis. + + ## Verbesserungen + + * Changelog-Updates mit Tags versehen, damit Endbenutzer Updates filtern können + * Sonnet-3.7 wird für KI-Chat unterstützt. Konfigurieren Sie Ihr bevorzugtes Modell über das Dashboard + * Ändern Sie Ihren Deployment-Namen direkt in den Dashboard-Einstellungen + + ## Fehlerbehebungen + + * OG-Bilder behoben + * Symbol-Stil-Inkonsistenz für Anker ohne Container behoben + * Verbesserte Styling-Details für Dashboard-Rahmen bei Mobilgerät-Tablet-Desktop-Responsivität + * Code-Beispiele auch im einfachen Modus für API-Playground anzeigen + * Unterstützung für "Befehl + k" Tastenkombination für Suche im Web-Editor + * Codeblöcke innerhalb von Callouts dehnen sich auf die volle Breite des Callout-Bereichs aus + + + + ## Neues Konfigurationsschema`docs.json` + + Wir haben ein neues `docs.json` Schema als Ersatz für `mint.json` eingeführt, um bessere mehrstufige Versionierung, einfachere visuelle Erfassung und konsistentere Terminologie zu unterstützen. Für weitere Informationen zu den Änderungen, [lesen Sie unseren Blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json). + + Upgrade von `mint.json` auf `docs.json` mit den folgenden Schritten: + + 1. Stellen Sie sicher, dass Ihre CLI auf der neuesten Version ist + + ``` + npm i mintlify@latest -g + ``` + + 1. Führen Sie in Ihrem Docs-Repository aus + + ``` + mintlify upgrade + ``` + + 1. Löschen Sie Ihre alte mint.json-Datei und übertragen Sie Ihre Änderungen + + ## CI-Prüfungen + + Prüfen Sie Ihre Dokumente automatisch auf defekte Links, entdecken Sie Rechtschreib- und Grammatikprobleme oder erzwingen Sie Schreibstile mit Ihrer eigenen Vale-Konfiguration. Erfahren Sie mehr in unserer [Dokumentation](settings/ci). + + ## .md-Unterstützung für LLMs + + Alle Dokumentationsseiten sind jetzt automatisch als einfache Markdown-Dateien verfügbar - fügen Sie einfach `.md` zur URL hinzu. Dies erleichtert es LLMs, einzelne Seiten aus Ihrer Dokumentation zu verarbeiten. + + ## Mehr Themes + + Neue [vorgefertigte Themes](/themes) zur Änderung des Erscheinungsbilds Ihrer Dokumentation. Konfigurieren Sie über Ihre [docs.json-Datei](/settings/global). + + Jetzt verfügbar: + + * Maple + * Palm + * Willow + + ## Weitere Verbesserungen + + * [Leitfaden zum technischen Schreiben:](https://mintlify.com/guides/introduction)Best Practices für das Schreiben technischer Dokumentation, einschließlich Zielgruppenforschung, Inhaltstypen und Schreibtipps. + * [Dropdown-Komponente](/navigation/divisions#dropdowns): Organisation der Navigation mit einem Dropdown-Menü, zusätzlich zu Tabs und Ankern. + * [KI-Syntax-Korrektor](https://x.com/ricardonunez_io/status/1892334887644123192): Der Web-Editor erkennt Parsing-Fehler und verwendet KI, um Korrekturen vorzuschlagen. + + + + ## KI-Assistent Verbesserungen + + * Neue Benutzeroberfläche mit dedizierter Chat-Seite & vorausgefüllten Prompts + * Stabilitätsverbesserungen, z.B. Fehlerbehebungen beim Bearbeiten der falschen Datei oder gar keiner Dateien + * Robusteres Wissen für das Hinzufügen & Bearbeiten von Komponenten + * Verbesserte mint.json-Datei-Bearbeitung + + ## Teilweise Authentifizierung + + Passen Sie den Zugriff auf jede Seite oder jeden Inhaltsbereich entsprechend den Benutzerberechtigungen an. Unterstützt die Verbindung mit Ihrem eigenen Authentifizierungssystem. + + ## Überarbeiteter API-Playground + + Wir haben das Design und die Leistung des [API-Playground](/api-playground/) überarbeitet. Updates beinhalten: + + * Einfachere Detailansicht für einen Überblick über ein Feld + * Intuitiveres verschachteltes Design, z.B. beim Hinzufügen oder Löschen von Elementen + * Schnellere Antwortzeiten + + ## Qualitätsverbesserungen + + * Unterstützung für die erforderliche Authentifizierung für den Zugriff auf Vorschau-Deployments + + + + ## Authentifizierung + + + ![Authentication screenshot](/images/changelog/authentication.png) + + + Machen Sie Docs privat, indem Sie die Authentifizierung über JWT, OAuth oder ein universelles Passwort einrichten. Mit dieser Privatsphäre können Sie eine interne Wissensdatenbank erstellen oder verhindern, dass Konkurrenten Ihre Dokumentation sehen. + + + + ## KI-Assistent + + + ![AI Assistant](/images/changelog/ai-assistant.jpg) + + + Sie können jetzt die KI bitten, Änderungen an Ihrer Dokumentation vorzunehmen, mit dem Kontext der gesamten bestehenden Dokumentation. Geben Sie eine Aufforderung ein und der Assistent wird Änderungen vorschlagen, indem er einen Pull Request generiert. + + ## GitLab-Integration Upgrade + + Wir haben unsere Unterstützung für die Synchronisierung mit GitLab verbessert, wie zum Beispiel die Aktivierung automatischer Updates und Vorschau-Deployments. Schauen Sie sich unsere [GitLab-Dokumentation](/settings/gitlab) an, um loszulegen. + + ## Web-Editor + + + ![Web Editor](/images/changelog/webeditor.jpg) + + + Wir haben unseren Web-Editor überarbeitet, sodass Sie jetzt Dokumentationen mit einer vollständigen WYSIWYG-Erfahrung aktualisieren können, während die Synchronisierung mit Markdown erfolgt. + + Schauen Sie sich unsere [Dokumentation zum Einstieg in den Web-Editor](/web-editor). + + ## /llms.txt Unterstützung + + + ![llms.txt support](/images/changelog/llms.jpg) + + + Alle Docs-Instanzen werden jetzt automatisch unter /llms.txt und /llms-full.txt gehostet, damit LLMs Ihre Dokumentation leicht aufnehmen können. Für weitere Informationen lesen Sie die [Dokumentation zum neuen llms.txt Standard.](https://llmstxt.org) + + ## Lokalisierung + + Sie können jetzt Ihre Dokumentation lokalisieren, was ähnlich wie die Versionierung funktioniert. Fügen Sie eine `locale` zu einer Version hinzu, und fester Inhalt in Mintlify wie "War diese Seite hilfreich?" wird ebenfalls an die Sprache angepasst. + + ### Qualitätsverbesserungen + + * Chat- und Suchergebnisse basierend auf der aktuellen Version, die der Benutzer liest, zurückgeben + * Authentifizieren Sie Benutzer mit OAuth, zusätzlich zu JWT oder Shared Session Tokens. + + + + ## Changelogs + + Eine neue [Update-Komponente](/content/components/update) eingeführt, um Updates (wie dieses) einfacher für Ihre Benutzer anzuzeigen und zu melden. + + + ![Changelog](/images/changelog/changelog.jpg) + + + ## Code-Zeilen Hervorhebung + + Sie können jetzt Codezeilen in Ihrer Dokumentation hervorheben, um wichtige Teile zu betonen und die Aufmerksamkeit darauf zu lenken, indem Sie einen speziellen Kommentar nach dem Sprachbezeichner hinzufügen. Verwenden Sie geschweifte Klammern `{}` und geben Sie Zeilennummern oder Bereiche durch Kommas getrennt an. + + ```javascript Line Highlighting Example {1,3-5} + const greeting = "Hello, World!"; + function sayHello() { + console.log(greeting); + } + sayHello(); + ``` + + ````md + ```javascript Line Highlighting Example {1,3-5} + const greeting = "Hello, World!"; + function sayHello() { + console.log(greeting); + } + sayHello(); + ``` + ```` + + ## Codeblöcke im hellen Modus + + Codeblöcke haben jetzt eine helle Variante, die aktiviert werden kann, indem Sie Folgendes zu Ihrer `mint.json`: + + ```json + "codeBlock": { + "mode": "auto" + } + ``` + + ## Erweiterter Footer + + + ![Advanced Footer](/images/changelog/advanced-footer.gif) + + + Sie können jetzt mehr Links zum Standard-Footer hinzufügen. Dieses Upgrade bietet mehr Konsistenz zwischen Landing Pages und Dokumentation oder größere Anpassungsmöglichkeiten, wenn Sie bestimmte Seiten wie Social Media oder Status-Logs hervorheben möchten. + + ## Suche nach aktuellem Benutzer filtern + + Wenn die Personalisierung aktiviert ist, werden Suchergebnisse jetzt basierend auf dem aktuell angemeldeten Benutzer gefiltert, sodass sie nur die relevanten Inhalte sehen. + + ## Benutzerdefinierte Prompts für KI-Chat + + Sie können jetzt die Prompts für den KI-Chat anpassen. Bitte wenden Sie sich an den [Support](mailto:sales@mintlify.com), wenn Sie die Prompts anpassen möchten. + + ## Dashboard-Verbesserungen + + * Möglichkeit hinzugefügt, benutzerdefinierte Domain direkt über Dashboard-Einstellungen zu /docs zu ändern. + * Login- und Registrierungsseiten zusammengeführt, um Reibung und Verwirrung zu reduzieren. + * Discovery-Login-Flow implementiert, sodass Benutzer, die Mitglieder mehrerer Organisationen sind, jetzt zwischen ihnen wechseln können. + * Anmeldung mit Google OAuth hinzugefügt + * Möglichkeit hinzugefügt, neue Deployments über Dashboard-Einstellungen hinzuzufügen. + + ## Fehlerbehebungen + + * Führende Schrägstriche können jetzt in der Navigation verwendet werden. + * CSS- und JS-Dateien können jetzt im Web-Editor bearbeitet werden. + * Problem behoben mit `suggestEdit`, das nicht angezeigt wurde, auch wenn es aktiviert war. + * Tastaturnavigation für Suche und Chat korrigiert, sodass Sie jetzt die Auf- und Ab-Pfeiltasten verwenden können, um durch die Ergebnisse zu navigieren. + * Suchmaschinen dürfen keine durch Benutzer-Auth geschützten Seiten crawlen. + * Cache wird neu validiert, wenn eine Organisation gelöscht wird. + * Wir verwenden jetzt den Scalar OpenAPI-Parser zum Parsen von OpenAPI-Definitionen, was die Leistung verbessert, Parsing-Probleme behebt und bessere Fehlermeldungen liefert. + * Top-Level-Beschreibungen werden jetzt in API-Referenzseiten unterstützt, die automatisch aus OpenAPI-Definitionen generiert werden. + * Unterstützung für Inline-Style für Icons hinzugefügt + * Das Pop-in von benutzerdefiniertem CSS in der Dokumentation wurde behoben. + * Korrekte Anzeige von Inline-Code-Formatierung in Verbindung mit Links. + * Beibehaltung der Scrollposition beim Klicken auf den Zurück-Button im Browser. + + + + ## Benutzerdefinierte Schriftarten + + + ![Custom Fonts](/images/changelog/custom-fonts.jpeg) + + + Personalisieren Sie die Schriftart Ihrer Dokumentation mit Ihrer eigenen, auf einem CDN gehosteten Schriftart oder wählen Sie aus Google Fonts, um Ihre Dokumentation an Ihre Marke anzupassen. + + ## Bilder in Card-Komponenten + + Fügen Sie eine`img` Eigenschaft zu einer Karte hinzu, um ein Bild am oberen Rand der Karte anzuzeigen. Erfahren Sie mehr darüber[hier](/content/components/cards#image-card). + + ## Verbesserungen der Aktualisierungsgeschwindigkeit + + + ![Performance Improvements](/images/changelog/performance-improvements.png) + + + Für große Projekte (\~3.000 Dateien) ist der Download-Schritt für Dokumentationsaktualisierungen jetzt \~440x schneller - eine Zeitreduzierung um 99,8%. Insgesamt sind Datei-Downloads während Aktualisierungen jetzt \~5,5x schneller - eine Zeitreduzierung um 81,8%. + + ## SEO-Verbesserungen + + + ![SEO Improvements](/images/changelog/seo-improvements.jpeg) + + + Wir haben sowohl das mobile als auch das Desktop-Layout unserer Dokumentation verbessert, damit sie SEO-freundlicher sind - einschließlich der Hinzufügung von korrekten Aria-Tags zu Navbar- und Toggle-Elementen. + + ## Dashboard-Verbesserungen + + * App-Router-Migration im Dashboard. + * Suchanalysen sind jetzt im Dashboard verfügbar. + * Funktionalität zum Löschen einer Organisation wurde zum Dashboard hinzugefügt. + * GitLab-Verbindungs-UI implementiert. + * Fehlerhafte Analysedaten korrigiert. + * Add-ons können jetzt direkt über das Dashboard gekauft werden. + + ## Fehlerbehebungen + + * Ein Fehler wurde behoben, bei dem sich die obere Leiste nicht über die gesamte Bildschirmbreite erstreckte, wenn sie sich im benutzerdefinierten Modus befand und das Seitenleisten-Layout`sidenav`. + * Relative Positionierung des KI-Widgets korrigiert. + + ## Mehr + + * **Fehlerbehebung für API-Seiten**: API-Seiten können kompliziert sein, daher haben wir häufige Probleme aufgelistet, um Ihnen bei der schnellen Lösung zu helfen —[Dokumentation lesen](/api-playground/troubleshooting) + + + + ## OpenAPI-Referenzseiten + + * Endpunkte, die durch OpenAPI definiert sind und komplex und rekursiv sind, sind jetzt 98% kleiner. + * Wir zeigen jetzt[additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/)in OpenAPI-Seiten an. + + ## Datei-Uploads im API-Playground + + Standardmäßig werden API-Playground-Anfragen von Mintlify weitergeleitet. Jetzt können Sie`disableProxy`verwenden, um dieses Verhalten zu deaktivieren und Anfragetypen wie Datei-Uploads zu unterstützen. + + * [Erfahren Sie mehr über API-Konfigurationen](/settings/global#api-configurations) + + ## Mobile SEO-Verbesserungen + + Wir haben das mobile Layout unserer Dokumentation verbessert, damit es SEO-freundlicher ist - einschließlich der Hinzufügung von korrekten Aria-Tags zu Elementen. + + ## Support-Formular + + Wir haben ein detaillierteres Support-Formular zum Mintlify-Dashboard hinzugefügt. Sie können jetzt ein Formular einreichen, um mit uns in Kontakt zu treten. + + ## Fehlerbehebungen + + * Ein Fehler in der Segment-Integrationsfunktionalität wurde behoben. + * Wir geben jetzt detailliertere Fehlermeldungen für GitHub-Berechtigungen bei der Interaktion mit dem Editor aus. + * Fehler wurden behoben, bei denen die Navigation nicht richtig expandierte, wenn ein direkter Link verwendet wurde. + + + + ## KI-Widget + + + ![AI Widget](/images/changelog/widget.png) + + + Für`Pro`-Benutzer haben wir das Mintlify Widget eingeführt, eine Erweiterung Ihrer Dokumentation, um die Fragen Ihrer Benutzer zu beantworten, wann und wo sie gestellt werden. Sie können diesen KI-gesteuerten Chatbot auf jeder Webseite hinzufügen: Ihrer Landing Page, in Ihrem Produkt oder auf Ihren bestehenden Dokumentationsseiten. + + * [Blog-Ankündigung lesen](https://mintlify.com/blog/widget) + + ## Pro-Plan + + Wir haben auch unsere Preispläne für bessere Anpassungsfähigkeit und Skalierbarkeit aktualisiert. + + * [Blog-Ankündigung lesen](https://mintlify.com/blog/pro-plan) + + ## API-Playground Code-Beispiel-Synchronisation + + Wenn Sie API-Dokumentation durchsuchen, wird das ausgewählte Code-Beispiel jetzt über Ihre Seiten hinweg synchronisiert. + + ## Einblicke + + Derzeit in der Beta-Phase fasst diese Funktion häufige Benutzerfragen und -muster in leicht verdauliche Berichte zusammen, mit KI-gestützten Vorschlägen zur Verbesserung Ihres Produkts. + + + + ## Launch Week Highlights + + * Themes: Passen Sie Ihr Styling mit vorkonfigurierten Themes an. Fügen Sie einfach das Theme Quill, Prism oder Venus zu Ihrer`mint.json`-Datei hinzu, und es wird das Styling Ihrer Dokumentation aktualisieren. + * Suche V2: Direktes Abfragen von OpenAPI-Endpunkt-Beschreibungen und -Titeln, um API-Referenzseiten zu erreichen, Entfernen versteckter Seiten aus der Suche und ein verbessertes Suchleisten-UI. + * Web Editor-Verzweigung: Erstellen Sie Branches in unserem Web-Editor ohne IDE. + * Benutzerpersonalisierung: Authentifizieren Sie Benutzer mit Shared Session oder JWT, damit Sie ihnen personalisierte Inhalte anzeigen können, wie zum Beispiel das Vorausfüllen von API-Schlüsseln oder das Anzeigen spezifischer Inhalte für Kunden. + * OepenAPI Automation-Verbesserungen: Um API Playground-Seiten automatisch zu befüllen, können Sie ein`openapi` Feld zu einem Objekt in tabs oder anchors Arrays in der mint.json hinzufügen. + + + + ## Okta SSO + + Wir unterstützen jetzt die Anmeldung über Okta SAML und OIDC. + + ## Mintlify REST API + + Programmgesteuerte Aktualisierungen Ihrer Dokumentation auslösen. + + + + ## Benutzerdefinierter Modus + + Fügen Sie eine Konfiguration zu den Metadaten hinzu, um alle Elemente außer der oberen Leiste zu entfernen. + Beispielanwendungen: + + * Erstellen Sie ein benutzerdefiniertes globales Landing-Page-Setup mit benutzerdefinierten Komponenten + * Fügen Sie Vollbild-Videos oder Bildergalerien hinzu + * Betten Sie benutzerdefinierte iFrame-Demo-Elemente ein, um Interaktivität zu Ihrer Dokumentation hinzuzufügen + + Schauen Sie sich unsere [Custom Mode-Dokumentation](/page#custom-mode). + + + + ## Mintlify MDX für VSCode + + Rufen Sie Snippets unserer vorgefertigten Komponenten und Callouts direkt in VSCode auf.[Installieren Sie die Erweiterung hier](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets). + + + + ## Qualitätsverbesserungen + + * Dashboard-Verbesserungen: Sehen Sie Aktualisierungsprotokolle, um zu erfahren, was sich geändert hat und wie der Status einer Aktualisierung ist, wechseln Sie zwischen Mintlify-Projekten, um Bereitstellungen zu verwalten + * Versionierung mit Tabs vollständig unterstützt + * Wildcard-Weiterleitungen werden jetzt unterstützt + * CLI-Fehlererkennung: Wir zeigen jetzt die Position ungültiger Frontmatter an, wenn während der lokalen Entwicklung Parsing-Probleme auftreten + + + + ## Launch Week Highlights + + * Vorschau-Bereitstellungen: Wenn Sie einen Pull Request erstellen, generieren wir einen eindeutigen Link, der eine Live-Vorschau Ihrer Dokumentation in der Produktion zeigt. Sie können diesen Link mit Teammitgliedern teilen. + * Snippets V2: Wir unterstützen jetzt vollständig wiederverwendbare Komponenten und Variablen für Snippets. + * Open-Source MDX Engine: Wir haben zwei APIs bereitgestellt—getCompiledMdx und MDXComponent—damit Sie auf Mintlify Markdown und Code-Syntaxhervorhebung zugreifen können.[Beiträge zum Projekt](https://github.com/mintlify/mdx) sind willkommen. + * AI Chat Insights: Segmentieren Sie den Chat-Verlauf nach Datum und erhöhen Sie das AI Chat-Kontingent über das Dashboard, und sehen Sie, wie häufig eine bestimmte Anfrage auftritt. + diff --git a/de/code.mdx b/de/code.mdx new file mode 100644 index 000000000..f5873e9f0 --- /dev/null +++ b/de/code.mdx @@ -0,0 +1,39 @@ +--- +title: Code-Blöcke +description: Inline-Code und Code-Blöcke anzeigen +icon: code +--- + +## Grundlagen + +### Inline-Code + +Um ein `word` oder `phrase` als Code zu kennzeichnen, schließen Sie es in Backticks (\`) ein. + +``` +To denote a `word` or `phrase` as code, enclose it in backticks (`). +``` + +### Code-Block + +Verwenden Sie [umzäunte Code-Blöcke](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks), indem Sie Code in drei Backticks einschließen und den führenden Ticks die Programmiersprache Ihres Snippets folgen lassen, um Syntaxhervorhebung zu erhalten. Optional können Sie auch den Namen Ihres Codes nach der Programmiersprache schreiben. + +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` + +````md +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` +```` + +Besuchen Sie die [Code Block-Seite](/content/components/code) für ausführlichere Dokumentation. diff --git a/de/content/components/accordion-groups.mdx b/de/content/components/accordion-groups.mdx new file mode 100644 index 000000000..9ab7107cd --- /dev/null +++ b/de/content/components/accordion-groups.mdx @@ -0,0 +1,58 @@ +--- +title: Akkordeongruppen +description: Gruppieren Sie mehrere Akkordeons in einer einzelnen Anzeige. +icon: table-rows +--- + +Fügen Sie einfach``um Ihre bestehenden``Komponenten hinzu. + + + + Sie können andere Komponenten innerhalb von Akkordeons platzieren. + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + + Schauen Sie sich die[Akkordeon](/content/components/accordions)Dokumentation für alle unterstützten Eigenschaften an. + + + + Schauen Sie sich die[Akkordeon](/content/components/accordions)Dokumentation für alle unterstützten Eigenschaften an. + + + + + ````jsx Accordion Group Example + + + You can put other components inside Accordions. + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + + + Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + + + Check out the [Accordion](/content/components/accordions) docs for all the supported props. + + + ```` + + +`AccordionGroup`hat keine Eigenschaften. diff --git a/de/content/components/accordions.mdx b/de/content/components/accordions.mdx new file mode 100644 index 000000000..601a037d2 --- /dev/null +++ b/de/content/components/accordions.mdx @@ -0,0 +1,39 @@ +--- +title: Accordions +description: Eine Dropdown-Komponente zum Ein- und Ausblenden von Inhalten +icon: square-caret-down +--- + + + Sie können hier jeden beliebigen Inhalt einfügen. Schauen Sie sich[AccordionGroup](/content/components/accordion-groups) an, wenn Sie mehrere Accordions in einer einzelnen Anzeige gruppieren möchten. + + + + ```jsx Accordion Example + + You can put any content in here. + + ``` + + +## Props + + + Titel in der Accordion-Vorschau. + + + + Details unter dem Titel in der Accordion-Vorschau. + + + + Ob das Accordion standardmäßig geöffnet ist. + + + + Ein [Font Awesome Icon](https://fontawesome.com/icons), [Lucide Icon](https://lucide.dev/icons) oder SVG-Code + + + + Einer von "regular", "solid", "light", "thin", "sharp-solid", "duotone" oder "brands" + diff --git a/de/content/components/callouts.mdx b/de/content/components/callouts.mdx new file mode 100644 index 000000000..91f162e98 --- /dev/null +++ b/de/content/components/callouts.mdx @@ -0,0 +1,45 @@ +--- +title: Hinweisfelder +description: Verwenden Sie Hinweise, um auffälligen Kontext zu Ihrem Inhalt hinzuzufügen +icon: circle-exclamation +--- + +### Notiz-Hinweise + +Dies fügt eine Notiz im Inhalt hinzu + +```jsx +This adds a note in the content +``` + +### Warnungs-Hinweise + +Dies weist auf eine Warnung hin, auf die zu achten ist + +```jsx +This raises a warning to watch out for +``` + +### Info-Hinweise + +Dies lenkt die Aufmerksamkeit auf wichtige Informationen + +```jsx +This draws attention to important information +``` + +### Tipp-Hinweise + +Dies schlägt einen hilfreichen Tipp vor + +```jsx +This suggests a helpful tip +``` + +### Häkchen-Hinweise + +Dies zeigt uns einen geprüften Status + +```jsx +This brings us a checked status +``` diff --git a/de/content/components/card-groups.mdx b/de/content/components/card-groups.mdx new file mode 100644 index 000000000..4074b1e72 --- /dev/null +++ b/de/content/components/card-groups.mdx @@ -0,0 +1,50 @@ +--- +title: Kartengruppen +description: Zeigen Sie Karten nebeneinander im Rasterformat an +icon: rectangles-mixed +--- + +Die`CardGroup`Komponente ermöglicht es Ihnen, mehrere`Card`Komponenten zusammenzugruppieren. Sie wird am häufigsten verwendet, um mehrere Karten in derselben Spalte anzuordnen. + + + + Neque porro quisquam est qui dolorem ipsum quia dolor sit amet + + + + Lorem ipsum dolor sit amet, consectetur adipiscing elit + + + + Ut enim ad minim veniam, quis nostrud exercitation ullamco + + + + Excepteur sint occaecat cupidatat non proident + + + + + ```jsx Card Group Example + + + Neque porro quisquam est qui dolorem ipsum quia dolor sit amet + + + Lorem ipsum dolor sit amet, consectetur adipiscing elit + + + Ut enim ad minim veniam, quis nostrud exercitation ullamco + + + Excepteur sint occaecat cupidatat non proident + + + ``` + + +## Eigenschaften + + + Die Anzahl der Spalten pro Zeile + diff --git a/de/content/components/cards.mdx b/de/content/components/cards.mdx new file mode 100644 index 000000000..3337f4340 --- /dev/null +++ b/de/content/components/cards.mdx @@ -0,0 +1,71 @@ +--- +title: Karten +description: Hauptpunkte oder Links mit anpassbaren Icons hervorheben +icon: rectangle +--- + + + So verwenden Sie eine Karte mit einem Icon und einem Link. Durch Klicken auf diese Karte + gelangen Sie zur Kartengruppen-Seite. + + + + ```jsx Card Example + + This is how you use a card with an icon and a link. Clicking on this card + brings you to the Card Group page. + + ``` + + ```jsx Image Card Example + + Here is an example of a card with an image + + ``` + + +### Horizontale Karte + +Fügen Sie eine `horizontal` Eigenschaft zu einer Karte hinzu, um sie horizontal anzuzeigen. + + + Hier ist ein Beispiel einer horizontalen Karte + + +### Bildkarte + +Fügen Sie eine `img` Eigenschaft zu einer Karte hinzu, um ein Bild oben auf der Karte anzuzeigen. + + + Hier ist ein Beispiel einer Karte mit einem Bild + + +## Eigenschaften + + + Der Titel der Karte + + + + Ein [Font Awesome Icon](https://fontawesome.com/icons), [Lucide Icon](https://lucide.dev/icons), oder SVG-Code in `icon={}` + + + + Eine von `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands` + + + + Die Farbe des Icons als Hex-Code + + + + Die URL, zu der der Benutzer beim Klicken auf die Karte navigiert wird + + + + Macht die Karte kompakter und horizontal + + + + Die URL oder der lokale Pfad zu einem Bild, das oben auf der Karte angezeigt werden soll + diff --git a/de/content/components/code-groups.mdx b/de/content/components/code-groups.mdx new file mode 100644 index 000000000..68a5ff696 --- /dev/null +++ b/de/content/components/code-groups.mdx @@ -0,0 +1,52 @@ +--- +title: Code-Gruppen +description: Die CodeGroup-Komponente ermöglicht es Ihnen, Codeblöcke in einer durch + Tabs getrennten Anzeige zu kombinieren +icon: rectangle-code +--- + +Sie müssen [Codeblöcke](/content/components/code) erstellen und dann die `` Komponente darum herum hinzufügen. Jeder Codeblock muss einen Dateinamen haben, da wir die Namen für die Tab-Schaltflächen verwenden. + +Sehen Sie unten ein Beispiel für das Endergebnis. + + + ```javascript helloWorld.js + console.log("Hello World"); + ``` + + ```python hello_world.py + print('Hello World!') + ``` + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + + ````md Code Group Example + + + ```javascript helloWorld.js + console.log("Hello World"); + ``` + + ```python hello_world.py + print('Hello World!') + ``` + + ```java HelloWorld.java + class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } + } + ``` + + + ```` + diff --git a/de/content/components/code.mdx b/de/content/components/code.mdx new file mode 100644 index 000000000..390b20ca2 --- /dev/null +++ b/de/content/components/code.mdx @@ -0,0 +1,199 @@ +--- +title: Code-Blöcke +description: Code mit optionaler Syntaxhervorhebung anzeigen +icon: code +--- + + + ````md Code Block Example + ```javascript Code Block Example + const hello = "world"; + ``` + ```` + + +## Einfacher Code-Block + +Verwende [umzäunte Code-Blöcke](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) indem du Code in drei Backticks einschließt. + +``` +helloWorld(); +``` + +````md +``` +helloWorld(); +``` +```` + +## Syntaxhervorhebung + +Setze den Namen deiner Programmiersprache nach den drei Backticks für Syntaxhervorhebung. + +Wir nutzen [Prism](https://prismjs.com/#supported-languages) für Syntaxhervorhebung. [Test Drive Prism](https://prismjs.com/test.html#language=markup) listet alle unterstützten Sprachen auf. + +```java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` + +````md +```java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` +```` + +## Namen + +Füge nach der Programmiersprache einen Titel hinzu, um den Namen deines Code-Beispiels festzulegen. Der Text kann beliebig sein, solange er in einer Zeile steht. + +```javascript Code Block Example +const hello = "world"; +``` + +````md Code Block Example +```javascript Code Block Example +const hello = "world"; +``` +```` + +## Zeilenhervorhebung + +Hebe bestimmte Zeilen in deinen Code-Blöcken hervor, indem du einen speziellen Kommentar nach dem Sprachbezeichner hinzufügst. Verwende geschweifte Klammern`{}` und gib Zeilennummern oder Bereiche durch Kommas getrennt an. + +```javascript Line Highlighting Example {1,3-5} +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` + +````md +```javascript Line Highlighting Example {1,3-5} +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` +```` + +## Erweiterbar + +Wenn du einen langen Code-Block hast und`[expandable]` nach deinem Titel setzt, kannst du ihn ein- und ausklappen. + +```python library.py [expandable] +from datetime import datetime, timedelta +from typing import Dict, List, Optional +from dataclasses import dataclass + +@dataclass +class Book: + title: str + author: str + isbn: str + checked_out: bool = False + due_date: Optional[datetime] = None + +class Library: + def __init__(self): + self.books: Dict[str, Book] = {} + self.checkouts: Dict[str, List[str]] = {} # patron -> list of ISBNs + + def add_book(self, book: Book) -> None: + if book.isbn in self.books: + raise ValueError(f"Book with ISBN {book.isbn} already exists") + self.books[book.isbn] = book + + def checkout_book(self, isbn: str, patron: str, days: int = 14) -> None: + if patron not in self.checkouts: + self.checkouts[patron] = [] + + book = self.books.get(isbn) + if not book: + raise ValueError("Book not found") + + if book.checked_out: + raise ValueError("Book is already checked out") + + if len(self.checkouts[patron]) >= 3: + raise ValueError("Patron has reached checkout limit") + + book.checked_out = True + book.due_date = datetime.now() + timedelta(days=days) + self.checkouts[patron].append(isbn) + + def return_book(self, isbn: str) -> float: + book = self.books.get(isbn) + if not book or not book.checked_out: + raise ValueError("Book not found or not checked out") + + late_fee = 0.0 + if datetime.now() > book.due_date: + days_late = (datetime.now() - book.due_date).days + late_fee = days_late * 0.50 + + book.checked_out = False + book.due_date = None + + # Remove from patron's checkouts + for patron, books in self.checkouts.items(): + if isbn in books: + books.remove(isbn) + break + + return late_fee + + def search(self, query: str) -> List[Book]: + query = query.lower() + return [ + book for book in self.books.values() + if query in book.title.lower() or query in book.author.lower() + ] + +def main(): + library = Library() + + # Add some books + books = [ + Book("The Hobbit", "J.R.R. Tolkien", "978-0-261-10295-4"), + Book("1984", "George Orwell", "978-0-452-28423-4"), + ] + + for book in books: + library.add_book(book) + + # Checkout and return example + library.checkout_book("978-0-261-10295-4", "patron123") + late_fee = library.return_book("978-0-261-10295-4") + print(f"Late fee: ${late_fee:.2f}") + +if __name__ == "__main__": + main() +``` + +````md +```javascript Expandable Example [expandable] +const greeting = "Hello, World!"; +function sayHello() { + console.log(greeting); +} +sayHello(); +``` +```` + +## Code-Gruppen + +Möchtest du mehrere Code-Beispiele in einer Code-Box anzeigen? Sieh dir die Code-Gruppen-Dokumentation an: + + + Lies die Referenz für die Code-Gruppen-Komponente + diff --git a/de/content/components/expandables.mdx b/de/content/components/expandables.mdx new file mode 100644 index 000000000..0353a81ce --- /dev/null +++ b/de/content/components/expandables.mdx @@ -0,0 +1,44 @@ +--- +title: Erweiterbare Elemente +description: Umschalten zur Anzeige verschachtelter Eigenschaften. +icon: caret-down +--- + + + + + Der vollständige Name des Benutzers + + + + Ob der Benutzer über 21 Jahre alt ist + + + + + + ```jsx Expandable Example + + + + The full name of the user + + + + Whether the user is over 21 years old + + + + ``` + + +## Eigenschaften + + + Der Name des Objekts, das Sie anzeigen. Wird verwendet, um den Text "NAME anzeigen" und + "NAME ausblenden" zu generieren. + + + + Auf true setzen, um die Komponente beim Laden der Seite geöffnet anzuzeigen. + diff --git a/de/content/components/frames.mdx b/de/content/components/frames.mdx new file mode 100644 index 000000000..c31f77bf5 --- /dev/null +++ b/de/content/components/frames.mdx @@ -0,0 +1,39 @@ +--- +title: Frames +description: Verwenden Sie die Frame-Komponente, um Bilder oder andere Komponenten in einen Container einzufassen. +icon: frame +--- + +Frames sind sehr nützlich, wenn Sie ein Bild zentrieren möchten. + + + + + +## Beschriftungen + +Sie können einem Bild zusätzlichen Kontext hinzufügen, indem Sie die optionale `caption` Eigenschaft verwenden. + + + + + +## Eigenschaften + + + Optionaler Beschriftungstext, der zentriert unter Ihrer Komponente angezeigt wird. + + + + ```jsx Frame + + + + ``` + + ```jsx Frame with Captions + + + + ``` + diff --git a/de/content/components/icons.mdx b/de/content/components/icons.mdx new file mode 100644 index 000000000..2068c3ff7 --- /dev/null +++ b/de/content/components/icons.mdx @@ -0,0 +1,42 @@ +--- +title: Icons +description: Verwenden Sie [Font Awesome](https://fontawesome.com/icons) oder + [Lucide](https://lucide.dev/icons) Icons überall in der Dokumentation +icon: icons +--- + + + + + ```jsx Icon Example + + ``` + + +## Inline Icons + +Das Icon wird inline platziert, wenn es in einem Absatz verwendet wird. + +```markdown Inline Icon Example + The documentation you want, effortlessly +``` + + Die Dokumentation, die Sie wollen, mühelos + +## Props + + + Ein [Font Awesome](https://fontawesome.com/icons) Icon + + + + Eines von `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands` + + + + Die Farbe des Icons als Hex-Code (z.B., `#FF5733`) + + + + Die Größe des Icons in Pixeln + diff --git a/de/content/components/mermaid-diagrams.mdx b/de/content/components/mermaid-diagrams.mdx new file mode 100644 index 000000000..8371c692c --- /dev/null +++ b/de/content/components/mermaid-diagrams.mdx @@ -0,0 +1,71 @@ +--- +title: Mermaid Diagramme +description: Diagramme mit Mermaid anzeigen +icon: diagram-project +--- + + + ````md Mermaid Flowchart Example + ```mermaid + flowchart LR + subgraph subgraph1 + direction TB + top1[top] --> bottom1[bottom] + end + subgraph subgraph2 + direction TB + top2[top] --> bottom2[bottom] + end + %% ^ These subgraphs are identical, except for the links to them: + + %% Link *to* subgraph1: subgraph1 direction is maintained + outside --> subgraph1 + %% Link *within* subgraph2: + %% subgraph2 inherits the direction of the top-level graph (LR) + outside ---> top2 + ``` + ```` + + +[Mermaid](https://mermaid.js.org/)ermöglicht es Ihnen, visuelle Diagramme mit Text und Code zu erstellen. + +```mermaid + flowchart LR + subgraph subgraph1 + direction TB + top1[top] --> bottom1[bottom] + end + subgraph subgraph2 + direction TB + top2[top] --> bottom2[bottom] + end + %% ^ These subgraphs are identical, except for the links to them: + + %% Link *to* subgraph1: subgraph1 direction is maintained + outside --> subgraph1 + %% Link *within* subgraph2: + %% subgraph2 inherits the direction of the top-level graph (LR) + outside ---> top2 +``` + +Sie können folgende Arten von Mermaid-Diagrammen erstellen: + +* Flussdiagramm +* Sequenzdiagramm +* Klassendiagramm +* Zustandsdiagramm +* Entity-Relationship-Diagramm +* Benutzerreise +* und mehr + +Eine vollständige Liste der von Mermaid unterstützten Diagramme finden Sie auf ihrer[Website](https://mermaid.js.org/). + +## Syntax für Mermaid-Diagramme + +Um ein Flussdiagramm zu erstellen, können Sie das Mermaid-Flussdiagramm innerhalb eines Mermaid-Codeblocks schreiben. + +````md +```mermaid +// Your mermaid code block here +``` +```` diff --git a/de/content/components/params.mdx b/de/content/components/params.mdx new file mode 100644 index 000000000..e37aa9b01 --- /dev/null +++ b/de/content/components/params.mdx @@ -0,0 +1,69 @@ +--- +title: Parameter-Felder +description: Pfad-, Abfrage- und Body-Parameter festlegen +icon: text-size +--- + +`ParamField` Komponenten helfen bei der Definition der Parameter für Ihre APIs oder SDKs. Das Hinzufügen eines ParamField fügt automatisch einen [API Playground](/api-playground/overview) hinzu. + + + Ein Beispiel eines Parameter-Felds + + + + ```jsx Path Example + + An example of a parameter field + + ``` + + ```jsx Query Example + + The filtering command used to sort through the users + + ``` + + ```jsx Body Example + + The age of the user. Cannot be less than 0 + + ``` + + +## Eigenschaften + + + Ob es sich um einen Abfrage-, Pfad-, Body- oder Header-Parameter handelt, gefolgt vom Namen + + + + Erwarteter Typ des Parameterwerts + + Unterstützt `number`, `string`, `bool`, `object`. + + Arrays können definiert werden mit dem `[]` Suffix. Zum Beispiel `string[]`. + + + + Gibt an, ob der Parameter erforderlich ist + + + + Gibt an, ob der Parameter veraltet ist + + + + Standardwert, der vom Server verwendet wird, wenn die Anfrage keinen Wert bereitstellt + + + + Wert, der zur Initialisierung des Playgrounds verwendet wird + + + + Platzhaltertext für die Eingabe im Playground + + + + Beschreibung des Parameters (Markdown aktiviert) + diff --git a/de/content/components/responses.mdx b/de/content/components/responses.mdx new file mode 100644 index 000000000..34260f1eb --- /dev/null +++ b/de/content/components/responses.mdx @@ -0,0 +1,37 @@ +--- +title: Antwortfelder +description: API-Antwortswerte anzeigen +icon: message +--- + +Die `` Komponente ist dafür konzipiert, die Rückgabewerte einer API zu definieren. Viele Dokumentationen verwenden auch `` auf Seiten, wenn Sie die Typen von etwas auflisten müssen. + + + Ein Antwortfeld-Beispiel + + + + ```jsx ResponseField Example + + A response field example + + ``` + + +## Eigenschaften + + + Der Name des Antwortwertes. + + + + Erwarteter Typ des Antwortwertes + + + + Der Standardwert. + + + + Zeigt "erforderlich" neben dem Feldnamen an. + diff --git a/de/content/components/steps.mdx b/de/content/components/steps.mdx new file mode 100644 index 000000000..e18d06213 --- /dev/null +++ b/de/content/components/steps.mdx @@ -0,0 +1,73 @@ +--- +title: Steps +description: Sequenzieren Sie Inhalte mit der Steps-Komponente +icon: arrow-progress +--- + +Steps sind die beste Möglichkeit, Ihren Benutzern eine Reihe von Aktionen oder Ereignissen anzuzeigen. Sie können beliebig viele Schritte hinzufügen. + + + + Dies sind Anweisungen oder Inhalte, die sich nur auf den ersten Schritt beziehen. + + + + Dies sind Anweisungen oder Inhalte, die sich nur auf den zweiten Schritt beziehen. + + + + Dies sind Anweisungen oder Inhalte, die sich nur auf den dritten Schritt beziehen. + + + + + ```jsx Steps Example + + + These are instructions or content that only pertain to the first step. + + + These are instructions or content that only pertain to the second step. + + + These are instructions or content that only pertain to the third step. + + + ``` + + +## Steps Props + + + Eine Liste von `Step` Komponenten. + + + + Die Größe der Schritttitel. Eine von`p`, `h2` und `h3`. + + +## Individuelle Schritt-Eigenschaften + + + Der Inhalt eines Schritts entweder als einfacher Text oder als Komponenten. + + + + Ein [Font Awesome Icon](https://fontawesome.com/icons), [Lucide Icon](https://lucide.dev/icons), oder SVG-Code in `icon={}` + + + + Eine von `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands` + + + + Der Titel ist der primäre Text für den Schritt und erscheint neben der Anzeige. + + + + Die Nummer des Schritts. + + + + Die Größe der Schritttitel. Eine von `p`, `h2` und `h3`. + diff --git a/de/content/components/sticky-examples.mdx b/de/content/components/sticky-examples.mdx new file mode 100644 index 000000000..31de550c3 --- /dev/null +++ b/de/content/components/sticky-examples.mdx @@ -0,0 +1,44 @@ +--- +title: Seitenleisten-Codebeispiele +description: Codeblöcke oben rechts auf der Seite auf Desktop-Geräten anzeigen +icon: sidebar-flip +--- + +Die `` und `` fixieren Codeblöcke oben rechts auf einer Seite, auch während Sie scrollen. Die Komponenten funktionieren auf allen Seiten, auch wenn Sie keinen API-Playground verwenden. + +`` und `` werden auf Mobilgeräten wie normale Codeblöcke angezeigt. + +## Anfrage-Beispiel + +Die `` Komponente funktioniert ähnlich wie [CodeGroup](/content/components/code-groups), zeigt aber den Anfrage-Inhalt in der rechten Seitenleiste an. Daher können Sie mehrere Codeblöcke innerhalb von `` platzieren. + +Bitte setzen Sie einen Namen für jeden Codeblock, den Sie in RequestExample platzieren. + + + ````md RequestExample Example + + + ```bash Request + curl --request POST \ + --url https://dog-api.kinduff.com/api/facts + ``` + + + ```` + + +## Antwort-Beispiel + +Die `` Komponente ist die gleiche wie `` wird aber darunter angezeigt. + + + ````md ResponseExample Example + + + ```json Response + { "status": "success" } + ``` + + + ```` + diff --git a/de/content/components/tabs.mdx b/de/content/components/tabs.mdx new file mode 100644 index 000000000..9aa43adf0 --- /dev/null +++ b/de/content/components/tabs.mdx @@ -0,0 +1,43 @@ +--- +title: Tabs +description: Inhalte mit der Tabs-Komponente umschalten +icon: window-restore +--- + +Sie können beliebig viele Tabs hinzufügen. + + + + ☝️ Willkommen bei dem Inhalt, den Sie nur im ersten Tab sehen können. + + + + ✌️ Hier ist der Inhalt, der nur im zweiten Tab zu finden ist. + + + + 💪 Hier ist der Inhalt, der nur im dritten Tab zu finden ist. + + + + + ```jsx Tabs Example + + + ☝️ Welcome to the content that you can only see inside the first Tab. + + + ✌️ Here's content that's only inside the second Tab. + + + 💪 Here's content that's only inside the third Tab. + + + ``` + + +## Tab-Eigenschaften + + + Der Titel des Tabs. Kurze Titel sind einfacher zu navigieren. + diff --git a/de/content/components/tooltips.mdx b/de/content/components/tooltips.mdx new file mode 100644 index 000000000..4fdbf5225 --- /dev/null +++ b/de/content/components/tooltips.mdx @@ -0,0 +1,13 @@ +--- +title: Tooltips +description: Zeigt eine Definition an, wenn Sie mit der Maus über Text fahren. +icon: message-lines +--- + +Fahren Sie mit der Maus über mich und sehen Sie einen Tooltip in Aktion + + + ```jsx Tooltip Example + Hover over me + ``` + diff --git a/de/content/components/update.mdx b/de/content/components/update.mdx new file mode 100644 index 000000000..5255929d5 --- /dev/null +++ b/de/content/components/update.mdx @@ -0,0 +1,57 @@ +--- +title: Update +description: Änderungen und Updates im Blick behalten +icon: rectangle-history +--- + +Die `Update` Komponente wird verwendet, um Änderungen und Updates zu verfolgen. + + + + + + + ## Änderungsprotokoll + + Sie können hier alles hinzufügen, wie einen Screenshot, ein Code-Snippet oder eine Liste von Änderungen. + + #### Funktionen + + * Responsives Design + * Fester Bereich für jedes Änderungsprotokoll + + + + ### Verwendung + + ```md + + This is how you use a changelog with a label + and a description. + + + This is how you use a changelog with a label + and a description. + + ``` + + Sie können mehrere `Update` Komponenten verwenden, um Änderungsprotokolle zu erstellen. + + + + Jede `label` erstellt einen Anker und erscheint auch im Inhaltsverzeichnis auf der rechten Seite. + + +## Eigenschaften + + + Beschriftung im Änderungsprotokoll, auf der festen linken Seite. + + + + Beschreibung unter der Beschriftung in der Änderungsprotokoll-Vorschau. + + + + Tags für das Änderungsprotokoll, werden als Filter im rechten Seitenbereich angezeigt + diff --git a/de/development.mdx b/de/development.mdx new file mode 100644 index 000000000..dfa5ce9ab --- /dev/null +++ b/de/development.mdx @@ -0,0 +1,120 @@ +--- +title: Lokale Entwicklung +description: Änderungen lokal vorschauen, um Ihre Dokumentation zu aktualisieren +--- + + + **Voraussetzung**: Bitte installieren Sie Node.js (Version 19 oder höher) bevor Sie fortfahren. + + +**Schritt 1**: Installieren Sie die Mintlify CLI: + + + ```bash npm + npm i -g mintlify + ``` + + ```bash yarn + yarn global add mintlify + ``` + + ```bash pnpm + pnpm add -g mintlify + ``` + + +**Schritt 2**: Navigieren Sie zum Dokumentationsverzeichnis (wo die `docs.json` Datei liegt) und führen Sie den folgenden Befehl aus: + +```bash +mintlify dev +``` + +Alternativ, wenn Sie die CLI nicht global installieren möchten, können Sie ein verfügbares Run-Skript verwenden: + + + ```bash npm + npx mintlify dev + ``` + + ```bash yarn + yarn dlx mintlify dev + ``` + + ```bash pnpm + pnpm dlx mintlify dev + ``` + + + + Yarns "dlx" Run-Skript erfordert Yarn Version >2. Siehe [hier](https://yarnpkg.com/cli/dlx) für weitere Informationen. + + +Eine lokale Vorschau Ihrer Dokumentation wird verfügbar sein unter `http://localhost:3000`. + +### Benutzerdefinierte Ports + +Standardmäßig verwendet Mintlify Port 3000. Sie können den Port mit dem `--port` Flag anpassen. Um Mintlify beispielsweise auf Port 3333 auszuführen, verwenden Sie diesen Befehl: + +```bash +mintlify dev --port 3333 +``` + +Wenn Sie versuchen, einen Port zu verwenden, der bereits belegt ist, wird der nächste verfügbare Port verwendet: + +```md +Port 3000 is already in use. Trying 3001 instead. +``` + +## Versionen + +Bitte beachten Sie, dass jede CLI-Version mit einer bestimmten Version von Mintlify verknüpft ist. Wenn Ihre lokale Website nicht mit der Produktionsversion übereinstimmt, aktualisieren Sie bitte die CLI: + + + ```bash npm + npm i -g mintlify@latest + ``` + + ```bash yarn + yarn global upgrade mintlify + ``` + + ```bash pnpm + pnpm up --global mintlify + ``` + + +## Links überprüfen + +Die CLI kann bei der Überprüfung von Referenzlinks in Ihrer Dokumentation helfen. Um fehlerhafte Links zu identifizieren, verwenden Sie den folgenden Befehl: + +```bash +mintlify broken-links +``` + +## Bereitstellung + +Wenn die Bereitstellung erfolgreich ist, sollten Sie Folgendes sehen: + + + + + +## Code-Formatierung + +Wir empfehlen die Verwendung von Erweiterungen in Ihrer IDE zur Erkennung und Formatierung von MDX. Wenn Sie VSCode-Benutzer sind, erwägen Sie die [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) für Syntaxhervorhebung und [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) für Code-Formatierung. + +## Fehlerbehebung + + + + Dies könnte an einer veralteten Version von Node liegen. Versuchen Sie Folgendes: + + 1. Entfernen Sie die aktuell installierte Version von Mintlify: `npm remove -g mintlify` + 2. Aktualisieren Sie auf Node v19 oder höher. + 3. Installieren Sie Mintlify neu: `npm install -g mintlify` + + + + Lösung: Gehen Sie zum Root-Verzeichnis Ihres Geräts und löschen Sie den Ordner \~/.mintlify. Führen Sie danach `mintlify dev` erneut aus. + + diff --git a/de/guides/auth0.mdx b/de/guides/auth0.mdx new file mode 100644 index 000000000..0577a4c36 --- /dev/null +++ b/de/guides/auth0.mdx @@ -0,0 +1,62 @@ +--- +title: Auth0 mit dem OAuth Handshake verwenden +description: Wenn Auth0 die Quelle der Wahrheit für Ihre Benutzerdaten ist, können Sie Mintlify als OAuth-Client-App einrichten, um Ihre Benutzer zu authentifizieren. +--- + + + **Sicherheitshinweis**: Während wir diese Anleitung zur Integration von Auth0 mit Mintlify bereitstellen, konsultieren Sie bitte Ihr Sicherheitsteam, bevor Sie eine Authentifizierungslösung implementieren. Mintlify ist nicht verantwortlich für eventuelle Sicherheitsprobleme, die durch Ihre spezifische Implementierung entstehen können. + + +## Übersicht + +Diese Anleitung führt Sie durch die Einrichtung von Auth0 als Authentifizierungsanbieter für Ihre Mintlify-Dokumentation. Am Ende können sich Ihre Benutzer mit ihren Auth0-Anmeldedaten in Ihrer Dokumentation anmelden. + + + + Melden Sie sich in Ihrem Auth0-Dashboard an und navigieren Sie zu **Anwendungen** > **Anwendungen**. Klicken Sie auf die **Anwendung erstellen** Schaltfläche, geben Sie Ihrer Anwendung einen Namen (z.B. "Mintlify") und wählen Sie **Reguläre Webanwendungen** als Anwendungstyp. Klicken Sie dann auf **Erstellen**. + + ![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png) + + + + Nach dem Erstellen Ihrer Anwendung gelangen Sie zur Seite mit den Anwendungseinstellungen. Hier finden Sie die wichtigsten Anmeldeinformationen für die OAuth-Integration: + + ![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png) + + Notieren Sie sich die folgenden Informationen: + + * **Domain**: Dies ist Ihre Auth0-Tenant-Domain (z.B. `your-tenant.auth0.com`) + * **Client ID**: Die öffentliche Kennung für Ihre Anwendung + * **Client Secret**: Der geheime Schlüssel für Ihre Anwendung (halten Sie diesen sicher) + + Sie benötigen diese Werte für die Konfiguration von Mintlify im nächsten Schritt. + + + + Navigieren Sie zu Ihrem Mintlify Dashboard und gehen Sie zu **Einstellungen** > **Authentifizierung** Bereich. Wählen Sie **OAuth** als Ihre Authentifizierungsmethode und Sie sehen das OAuth-Konfigurationsformular: + + ![Mintlify OAuth client settings](/images/guides/auth0/mintlifyoauthclientsettings.png) + + Füllen Sie das Formular mit den folgenden Werten aus: + + * **Authorization URL**: `https://YOUR_AUTH0_DOMAIN/authorize` (ersetzen Sie `YOUR_AUTH0_DOMAIN` durch Ihre tatsächliche Auth0-Domain aus Schritt 2) + * **Client ID**: Geben Sie die Client ID aus Ihrer Auth0-Anwendung ein + * **Client Secret**: Geben Sie das Client Secret aus Ihrer Auth0-Anwendung ein + * **Scopes**: Lassen Sie dies leer, es sei denn, Sie haben benutzerdefinierte Scopes in Auth0 eingerichtet + * **Token URL**: `https://YOUR_AUTH0_DOMAIN/oauth/token` (ersetzen Sie `YOUR_AUTH0_DOMAIN` durch Ihre tatsächliche Auth0-Domain) + + Nachdem Sie diese Details eingegeben haben, klicken Sie auf **Änderungen speichern**, um Ihre OAuth-Konfiguration zu speichern. + + + + Mintlify generiert eine eindeutige Weiterleitungs-URL, die Auth0 für den korrekten OAuth-Ablauf erkennen muss. + + Kopieren Sie die Weiterleitungs-URL aus den Authentifizierungseinstellungen Ihres Mintlify Dashboards: + ![Mintlify redirect URL](/images/guides/auth0/mintlifyredirecturl.png) + + Kehren Sie zur Einstellungsseite Ihrer Auth0-Anwendung zurück, scrollen Sie zum Abschnitt **Anwendungs-URIs** und fügen Sie die Weiterleitungs-URL in das Feld **Erlaubte Callback-URLs** ein: + ![Auth0 redirect URL configuration](/images/guides/auth0/auth0redirecturl.png) + + Klicken Sie auf **Änderungen speichern** am unteren Rand der Auth0-Seite, um diese Konfiguration anzuwenden. + + diff --git a/de/image-embeds.mdx b/de/image-embeds.mdx new file mode 100644 index 000000000..e2354e65e --- /dev/null +++ b/de/image-embeds.mdx @@ -0,0 +1,133 @@ +--- +title: Bilder, Videos und Einbettungen +description: Fügen Sie Bilder, Videos und andere HTML-Elemente hinzu +icon: image +--- + + + + + Mintlify unterstützt Dateien bis zu 5 MB. Für größere Dateien empfiehlt sich ein Speicherdienst + wie Cloudinary und die Einbettung in Ihre Dokumentation über die URL. + + +## Bild + +### Verwendung von Markdown + +Die[Markdown-Syntax](https://www.markdownguide.org/basic-syntax/#images)ermöglicht es Ihnen, Bilder mit folgendem Code hinzuzufügen + +```md +![title](/path/image.jpg) +``` + +Beachten Sie, dass die Bilddateigröße weniger als 5MB betragen muss. Andernfalls empfehlen wir das Hosting auf einem Dienst wie[Cloudinary](https://cloudinary.com/)oder[S3](https://aws.amazon.com/s3/). Sie können dann diese URL verwenden und einbetten. + +### Verwendung von Einbettungen + +Für mehr Anpassungsmöglichkeiten bei Bildern können Sie auch Einbettungen verwenden. + +```html + +``` + +### Bild-Zoom deaktivieren + +Um den standardmäßigen Zoom beim Klicken auf Bilder zu deaktivieren, fügen Sie die noZoom-Eigenschaft zu Bild-Einbettungen hinzu. + +```html + +``` + +### Bilder verlinken + +Um ein Bild zu verlinken, zum Beispiel um eine Schaltfläche in Ihrer Dokumentation zu erstellen, umschließen Sie das Bild mit einem Link mit der`noZoom`Eigenschaft. Bilder in`a`Tags haben automatisch einen Zeiger-Cursor. + +```html + + + +``` + +### Dunkelmodus + +Um separate Bilder für den hellen und dunklen Modus zu verwenden, nutzen Sie Tailwind CSS zum Ein- und Ausblenden von Bildern. + +```html + + +``` + +### Verwandte Themen + +Für weitere Informationen empfehlen wir die folgenden Abschnitte: + + + Lesen Sie die Referenz für die Frame-Komponente + + +## Videos + + +``` + +Für andere Videos verwenden Sie: + +```html + +``` + +Um das Video automatisch abzuspielen, verwenden Sie: + +```html + +``` + + + Da Mintlify sich an die JSX-Syntax halten muss, müssen Attribute mit zwei Wörtern in + camelCase geschrieben werden: autoPlay, playsInline. + + +## iFrames + +Lädt eine andere HTML-Seite innerhalb des Dokuments. + +```html + +``` + + + Obwohl nicht erforderlich, empfehlen wir das Hinzufügen der`alt`und`title`Attribute für + Bilder für bessere SEO und Zugänglichkeit. Erfahren Sie mehr unter[Bild- + SEO](https://yoast.com/image-seo-alt-tag-and-title-tag-optimization/). + diff --git a/de/integrations/analytics/amplitude.mdx b/de/integrations/analytics/amplitude.mdx new file mode 100644 index 000000000..d1c9466b1 --- /dev/null +++ b/de/integrations/analytics/amplitude.mdx @@ -0,0 +1,23 @@ +--- +title: Amplitude +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an Amplitude zu senden. + + + ```json Analytics options in docs.json + "integrations": { + "amplitude": { + "apiKey": "required" + } + } + ``` + + ```json Example + "integrations": { + "amplitude": { + "apiKey": "76bb138bf3fbf58186XXX00000" + } + } + ``` + diff --git a/de/integrations/analytics/clearbit.mdx b/de/integrations/analytics/clearbit.mdx new file mode 100644 index 000000000..5f353943f --- /dev/null +++ b/de/integrations/analytics/clearbit.mdx @@ -0,0 +1,23 @@ +--- +title: Clearbit +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an Clearbit zu senden. + + + ```json Analytics options in docs.json + "integrations": { + "clearbit": { + "publicApiKey": "required" + } + } + ``` + + ```json Example + "integrations": { + "clearbit": { + "publicApiKey": "pk_1a1882" + } + } + ``` + diff --git a/de/integrations/analytics/fathom.mdx b/de/integrations/analytics/fathom.mdx new file mode 100644 index 000000000..259555c60 --- /dev/null +++ b/de/integrations/analytics/fathom.mdx @@ -0,0 +1,25 @@ +--- +title: Fathom +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an Fathom zu senden. + +Sie können die`siteId` aus Ihren Skript-Einstellungen erhalten. + + + ```json Analytics options in docs.json + "integrations": { + "fathom": { + "siteId": "required" + } + } + ``` + + ```json Example + "integrations": { + "fathom": { + "siteId": "YSVMSDAY" + } + } + ``` + diff --git a/de/integrations/analytics/google-analytics.mdx b/de/integrations/analytics/google-analytics.mdx new file mode 100644 index 000000000..9a1665972 --- /dev/null +++ b/de/integrations/analytics/google-analytics.mdx @@ -0,0 +1,43 @@ +--- +title: Google Analytics 4 +--- + +Sie müssen eine neueGA4Property erstellen, um sie mit Mintlify zu verwenden. Die gesammelten Daten werden in dasselbe Projekt wie Ihre anderen Google Analytics-Daten aufgenommen. + +Wenn Sie die alte Version von Google Analytics, Universal Analytics, verwenden, können Sie immer noch ein GA4 Property erstellen. GA4 Daten unterscheiden sich leicht von UA-Daten, werden aber immer noch im selben Projekt gesammelt. + +## So verbinden Sie GA4 mit Mintlify + +### Web-Stream erstellen + +Sie müssen einen Web-Stream erstellen, um die Measurement ID zu erhalten, die Sie in Mintlify einfügen müssen. + +Klicken Sie auf das Zahnrad unten links im Google Analytics-Bildschirm. Klicken Sie dann auf Datenstreams. + +![](/images/ga4-web-streams.png) + +Erstellen Sie einen Web-Stream und geben Sie die URL Ihrer Mintlify-Dokumentationsseite als Stream-URL ein. + +Ihre Measurement ID sieht aus wie `G-XXXXXXX` und wird unter Stream-Details sofort nach der Erstellung des Web-Streams angezeigt. + +### Measurement ID in docs.json einfügen + +Fügen Sie Ihre Measurement ID in Ihre `docs.json` Datei wie folgt ein: + +```json docs.json +"integrations": { + "ga4": { + "measurementId": "G-XXXXXXX" + } +} +``` + +### Warten + +Google Analytics braucht zwei bis drei Tage, um Ihre Daten anzuzeigen. + +Sie können den [Google Analytics Debugger](https://chrome.google.com/webstore/detail/google-analytics-debugger/jnkmfdileelhofjcijamephohjechhna?hl=en) verwenden, um zu überprüfen, ob Analytics korrekt aktiviert ist. Die Erweiterung protokolliert in der Konsole Ihres Browsers jede GA4-Anfrage. + + + Vorschau-Links haben Analytics deaktiviert. + diff --git a/de/integrations/analytics/google-tag-manager.mdx b/de/integrations/analytics/google-tag-manager.mdx new file mode 100644 index 000000000..e72f97730 --- /dev/null +++ b/de/integrations/analytics/google-tag-manager.mdx @@ -0,0 +1,25 @@ +--- +title: Google Tag Manager +--- + +Fügen Sie Ihre Tag-ID zu`docs.json` hinzu und wir fügen das Google Tag Manager-Skript in alle Ihre Seiten ein. + +Sie sind dafür verantwortlich, Cookie-Zustimmungsbanner mit Google Tag Manager einzurichten, wenn Sie diese benötigen. + + + ```json Analytics options in docs.json + "integrations": { + "gtm": { + "tagId": "required" + } + } + ``` + + ```json Example + "integrations": { + "gtm": { + "tagId": "GTM-MGBL4PW" + } + } + ``` + diff --git a/de/integrations/analytics/heap.mdx b/de/integrations/analytics/heap.mdx new file mode 100644 index 000000000..b7fad58cb --- /dev/null +++ b/de/integrations/analytics/heap.mdx @@ -0,0 +1,23 @@ +--- +title: Heap +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an Heap zu senden. + + + ```json Analytics options in docs.json + "integrations": { + "heap": { + "appId": "required" + } + } + ``` + + ```json Example + "integrations": { + "heap": { + "appId": "1234567890" + } + } + ``` + diff --git a/de/integrations/analytics/hotjar.mdx b/de/integrations/analytics/hotjar.mdx new file mode 100644 index 000000000..44e56985a --- /dev/null +++ b/de/integrations/analytics/hotjar.mdx @@ -0,0 +1,14 @@ +--- +title: HotJar +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an HotJar zu senden. + +```json Analytics options in docs.json +"integrations": { + "hotjar": { + "hjid": "required", + "hjsv": "required" + } +} +``` diff --git a/de/integrations/analytics/koala.mdx b/de/integrations/analytics/koala.mdx new file mode 100644 index 000000000..dcea67f2e --- /dev/null +++ b/de/integrations/analytics/koala.mdx @@ -0,0 +1,23 @@ +--- +title: Koala +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an Koala zu senden. + + + ```json Analytics options in docs.json + "integrations": { + "koala": { + "publicApiKey": "required" + } + } + ``` + + ```json Example + "integrations": { + "koala": { + "publicApiKey": "pk_1a1882" + } + } + ``` + diff --git a/de/integrations/analytics/logrocket.mdx b/de/integrations/analytics/logrocket.mdx new file mode 100644 index 000000000..8de2a5cf7 --- /dev/null +++ b/de/integrations/analytics/logrocket.mdx @@ -0,0 +1,13 @@ +--- +title: LogRocket +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an LogRocket zu senden. + +```json Analytics options in docs.json +"integrations": { + "logrocket": { + "apiKey": "required" + } +} +``` diff --git a/de/integrations/analytics/mixpanel.mdx b/de/integrations/analytics/mixpanel.mdx new file mode 100644 index 000000000..e756939f0 --- /dev/null +++ b/de/integrations/analytics/mixpanel.mdx @@ -0,0 +1,13 @@ +--- +title: Mixpanel +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um Analytics an Mixpanel zu senden. + +```json Analytics options in docs.json +"integrations": { + "mixpanel": { + "projectToken": "required" + } +} +``` diff --git a/de/integrations/analytics/overview.mdx b/de/integrations/analytics/overview.mdx new file mode 100644 index 000000000..c22b534be --- /dev/null +++ b/de/integrations/analytics/overview.mdx @@ -0,0 +1,612 @@ +--- +title: Analytics Integrationen +description: Integration mit einer Analytics-Plattform zur Ereignisverfolgung +--- + +Senden Sie automatisch Daten über die Nutzung Ihrer Dokumentation an Ihren Drittanbieter für Analytics. + +## Alle Integrationen + + + + + +} + /> + + + + + + +} + /> + + + + + + + + +} + /> + + + + + + + + + + +} + /> + + + + + + + + + + +} + /> + + + + + +} + /> + + + + + +} + /> + + + + + + +} + /> + + + + + + + + + + + + + + + + + + + + + + + + + + + +} + /> + + + + + + + + + + + + + + + + + + + + + + + + + + +} + /> + + + + + + + +} + /> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +} + /> + + + + + +} + /> + + + + + + + + +} + /> + + +## Analytics aktivieren + +Legen Sie Ihre Analytics-Schlüssel fest in `docs.json`. Sie können kostenlos unbegrenzt viele Analytics-Integrationen hinzufügen. + +Die Syntax für `docs.json` ist unten aufgeführt. Sie müssen nur Einträge für die Plattformen hinzufügen, die Sie verbinden möchten. + + + ```json Analytics options in docs.json + "integrations": { + "amplitude": { + "apiKey": "required" + }, + "clearbit": { + "publicApiKey": "required" + }, + "fathom": { + "siteId": "required" + }, + "ga4": { + "measurementId": "required" + }, + "gtm": { + "tagId": "required" + }, + "hotjar": { + "hjid": "required", + "hjsv": "required" + }, + "koala": { + "publicApiKey": "required" + }, + "logrocket": { + "appId": "required" + }, + "mixpanel": { + "projectToken": "required" + }, + "pirsch": { + "id": "required" + }, + "plausible": { + "domain": "required" + }, + "posthog": { + "apiKey": "required", + "apiHost": "optional" + }, + "segment": { + "key": "required" + }, + } + ``` + + ```json Google Analytics 4 Example + "integrations": { + "ga4": { + "measurementId": "G-XXXXXXX" + } + } + ``` + + +## FAQ + + + * `expandable_open` + + * `expandable_close` + + * `accordion_open` + + * `accordion_close` + + * `header_nav_item_click` + + * `cta_click` + + * `scroll_to_bottom` + + * `search_close` + + * `api_playground_call` + + * `search_result_click` + + * `chat_enter` + + * `chat_followup` + + * `chat_completed` + + * `code_block_copy` + + * `chat_shared` + + * `thumb_vote` + + * `powered_by_mintlify_click` + + * `ai_chat_citation_click` + + * `ai_chat_feedback_positive_click` + + * `ai_chat_feedback_negative_click` + + * `pageview` + diff --git a/de/integrations/analytics/pirsch.mdx b/de/integrations/analytics/pirsch.mdx new file mode 100644 index 000000000..313b46728 --- /dev/null +++ b/de/integrations/analytics/pirsch.mdx @@ -0,0 +1,25 @@ +--- +title: Pirsch +--- + +Fügen Sie Folgendes zu Ihrer `docs.json` Datei hinzu, um Analysen an Pirsch zu senden. + +Sie können Ihre Site-ID unter Einstellungen > Entwickler > Identifikationscode finden. + + + ```json Analytics options in docs.json + "integrations": { + "pirsch": { + "id": "required" + } + } + ``` + + ```json Example + "integrations": { + "pirsch": { + "id": "8Kw7OKxBfswOjnKGZa7P9Day8JmVYwTp" + } + } + ``` + diff --git a/de/integrations/analytics/plausible.mdx b/de/integrations/analytics/plausible.mdx new file mode 100644 index 000000000..b19ce9dd0 --- /dev/null +++ b/de/integrations/analytics/plausible.mdx @@ -0,0 +1,28 @@ +--- +title: Plausible +--- + +Fügen Sie die Domain Ihrer Website zu `docs.json` um Analytics an Plausible zu senden. + + + Nicht einschließen`https://` für die Domain oder den Server. + + + + ```json Analytics options in docs.json + "integrations": { + "plausible": { + "domain": "required", + "server": "optional" + } + } + ``` + + ```json Example + "integrations": { + "plausible": { + "domain": "docs.domain.com" + } + } + ``` + diff --git a/de/integrations/analytics/posthog.mdx b/de/integrations/analytics/posthog.mdx new file mode 100644 index 000000000..2e8bd6439 --- /dev/null +++ b/de/integrations/analytics/posthog.mdx @@ -0,0 +1,36 @@ +--- +title: PostHog +--- + +Fügen Sie Folgendes zu Ihrer `docs.json` Datei hinzu, um Analysen an PostHog zu senden. + +Sie müssen nur `apiHost` einschließen, wenn Sie PostHog selbst hosten. Wir senden Events standardmäßig an `https://app.posthog.com`. + + + ```json Analytics options in docs.json + "integrations": { + "posthog": { + "apiKey": "YOUR_POSTHOG_PROJECT_API_KEY", + "apiHost": "optional" + } + } + ``` + + ```json Example + "integrations": { + "posthog": { + "apiKey": "phc_TXdpocbYTeZVm5VJmMzHTMrCofBQu3e0kN7HGMNGTVW" + } + } + ``` + + +
+ + + Das Aktivieren von PostHog Analytics deaktiviert die Analysen im Mintlify Dashboard. + + +## Sitzungsaufzeichnungen + +Sie müssen die URL Ihrer Dokumentationswebsite zu Posthogs "Autorisierte Domains für Aufzeichnungen" hinzufügen, bevor Sie Sitzungsaufzeichnungen erhalten können. Die Option zum Hinzufügen Ihrer URL befindet sich in den Projekteinstellungen von Posthog. diff --git a/de/integrations/analytics/segment.mdx b/de/integrations/analytics/segment.mdx new file mode 100644 index 000000000..dfaee75b5 --- /dev/null +++ b/de/integrations/analytics/segment.mdx @@ -0,0 +1,23 @@ +--- +title: Segment +--- + +Fügen Sie Ihren Segment-Write-Key zu Ihrer `docs.json` Datei hinzu, um Analytics an Segment zu senden. + + + ```json Analytics options in docs.json + "integrations": { + "segment": { + "key": "required", + } + } + ``` + + ```json Example + "integrations": { + "segment": { + "key": "nqJxiRG15Y6M594P8Sb8ESEciU3VC2" + } + } + ``` + diff --git a/de/integrations/privacy/osano.mdx b/de/integrations/privacy/osano.mdx new file mode 100644 index 000000000..5766e498c --- /dev/null +++ b/de/integrations/privacy/osano.mdx @@ -0,0 +1,25 @@ +--- +title: Osano +--- + +Fügen Sie Folgendes zu Ihrer`docs.json` Datei hinzu, um den [Osano](https://www.osano.com/) Cookie-Consent-Manager hinzuzufügen. + + + ```json Integration options in docs.json + "integrations": { + "osano": "SOURCE" + } + ``` + + ```json Example + "integrations": { + "osano": "https://cmp.osano.com/2sUB2dqwqdkks/8dqwd-dwd86£-4a9b/osano.js" + } + ``` + + +Die `SOURCE` ist zu finden als `src` Wert im von Osano generierten Code-Snippet. Es beginnt immer mit `https://cmp.osano.com/`. + +```html Code snippet from Osano +