Skip to content

Commit 994871d

Browse files
Documentation edits made through Mintlify web editor
1 parent 3ccba78 commit 994871d

File tree

107 files changed

+9308
-221
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+9308
-221
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Editor-Berechtigungen
3+
description: Erlauben Sie mehr Teammitgliedern, Ihre Dokumentation zu aktualisieren
4+
---
5+
6+
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.
7+
8+
Wenn ein anderer Editor versucht, die Dokumentation im kostenlosen Plan zu aktualisieren, werden Sie eine Warnung in Ihrer Git-Commit-Prüfung sehen.
9+
10+
<Frame>
11+
<img className="rounded-md" src="/images/editor-gate.png" />
12+
</Frame>
13+
14+
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.
15+
16+
Erfahren Sie mehr über unsere Preise [hier](https://mintlify.com/pricing).

de/advanced/dashboard/sso.mdx

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: Single Sign-On (SSO)
3+
description: Passen Sie an, wie sich Ihr Team in Ihrem Admin-Dashboard anmelden kann
4+
---
5+
6+
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!
7+
8+
<Note>
9+
SSO-Funktionalität ist in unserem Enterprise-Plan verfügbar.[Kontaktieren
10+
Sie uns](https://mintlify.com/enterprise) um mehr zu erfahren!
11+
</Note>
12+
13+
## Okta
14+
15+
<Tabs>
16+
<Tab title="SAML">
17+
<Steps>
18+
<Step title="Create an application">
19+
Unter `Applications`, klicken Sie, um eine neue App-Integration mit SAML 2.0 zu erstellen.
20+
</Step>
21+
22+
<Step title="Configure integration">
23+
Geben Sie Folgendes ein:
24+
25+
* Single Sign-on URL (von Mintlify bereitgestellt)
26+
* Audience URI (von Mintlify bereitgestellt)
27+
* Name ID Format: `EmailAddress`
28+
* Attributanweisungen:
29+
| Name | Namensformat | Wert |
30+
| ----------- | ------------ | ---------------- |
31+
| `firstName` | Basic | `user.firstName` |
32+
| `lastName` | Basic | `user.lastName` |
33+
</Step>
34+
35+
<Step title="Send us your IdP information">
36+
Sobald die Anwendung eingerichtet ist, navigieren Sie zum Sign-on-Tab und senden Sie uns die Metadata-URL.
37+
Wir werden die Verbindung von unserer Seite mit diesen Informationen aktivieren.
38+
</Step>
39+
</Steps>
40+
</Tab>
41+
42+
<Tab title="OIDC">
43+
<Steps>
44+
<Step title="Create an application">
45+
Unter `Applications`, klicken Sie, um eine neue App-Integration mit OIDC zu erstellen.
46+
Sie sollten den `Web Application` Anwendungstyp wählen.
47+
</Step>
48+
49+
<Step title="Configure integration">
50+
Wählen Sie den Autorisierungscode-Grant-Typ und geben Sie die von Mintlify bereitgestellte Redirect-URI ein.
51+
</Step>
52+
53+
<Step title="Send us your IdP information">
54+
Sobald die Anwendung eingerichtet ist, navigieren Sie zum Allgemeinen Tab und finden Sie die Client-ID & das Client-Secret.
55+
Bitte stellen Sie uns diese zusammen mit Ihrer Okta-Instanz-URL sicher zur Verfügung (z.B. `<your-tenant-name>.okta.com`). Sie können diese über einen Dienst wie 1Password oder SendSafely senden.
56+
</Step>
57+
</Steps>
58+
</Tab>
59+
</Tabs>
60+
61+
## Google Workspace
62+
63+
<Tabs>
64+
<Tab title="SAML">
65+
<Steps>
66+
<Step title="Create an application">
67+
Unter `Web and mobile apps`, wählen Sie `Add custom SAML app` aus dem `Add app` Dropdown-Menü.
68+
69+
<Frame>
70+
![](/images/gsuite-add-custom-saml-app.png)
71+
</Frame>
72+
</Step>
73+
74+
<Step title="Send us your IdP information">
75+
Kopieren Sie die bereitgestellte SSO-URL, Entity ID und das x509-Zertifikat und senden Sie diese an das Mintlify-Team.
76+
77+
<Frame>
78+
![](/images/gsuite-saml-metadata.png)
79+
</Frame>
80+
</Step>
81+
82+
<Step title="Configure integration">
83+
Geben Sie auf der Seite für Service-Provider-Details Folgendes ein:
84+
85+
* ACS URL (von Mintlify bereitgestellt)
86+
* Entity ID (von Mintlify bereitgestellt)
87+
* Name ID Format: `EMAIL`
88+
* Name ID: `Basic Information > Primary email`
89+
90+
<Frame>
91+
![](/images/gsuite-sp-details.png)
92+
</Frame>
93+
94+
Geben Sie auf der nächsten Seite die folgenden Attributanweisungen ein:
95+
96+
| Google Verzeichnisattribut | App-Attribut |
97+
| -------------------------- | ------------ |
98+
| `First name` | `firstName` |
99+
| `Last name` | `lastName` |
100+
101+
Sobald dieser Schritt abgeschlossen ist und die Benutzer der Anwendung zugewiesen sind, informieren Sie unser Team und wir aktivieren SSO für Ihr Konto!
102+
</Step>
103+
</Steps>
104+
</Tab>
105+
</Tabs>

de/advanced/mcp/generate.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: MCP Generator
3+
description: Lernen Sie, wie Sie Ihren eigenen MCP Server einrichten
4+
icon: 'text-size'
5+
---
6+
7+
<Tip>
8+
Diese Seite widmet sich der Einrichtung Ihres eigenen MCP Servers. Wenn Sie Informationen zur Verwendung des Mintlify MCP Servers suchen, lesen Sie bitte die
9+
[Installation und Verwendung des Mintlify MCP Servers](/advanced/mcp/quickstart) Seite.
10+
</Tip>
11+
12+
## Erste Schritte
13+
14+
Führen Sie `npm i @mintlify/mcp` aus, um die `@mintlify/mcp` CLI zu installieren.
15+
16+
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.
17+
18+
<Note>
19+
Stellen Sie sicher, dass Sie den OpenAPI-Zugriff aktivieren, damit der MCP-Server auf **alle**
20+
Endpunkte in Ihrer OpenAPI-Spezifikation zugreifen kann.
21+
</Note>
22+
23+
## Starten Sie den MCP-Server lokal
24+
25+
<Steps>
26+
<Step title="Install the server through the CLI">
27+
Führen Sie den folgenden Befehl aus, um den Server zu installieren:
28+
29+
```bash
30+
npx @mintlify/mcp add [your subdomain]
31+
```
32+
</Step>
33+
34+
<Step title="Add the authentication token if applicable">
35+
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
36+
(basic token)?` Andernfalls können Sie diesen Schritt überspringen.
37+
</Step>
38+
39+
<Step title="Start your MCP server">
40+
Sie können jetzt ausführen: `bash npm --prefix ~/.mcp/[your subdomain] start `
41+
</Step>
42+
</Steps>

de/advanced/mcp/quickstart.mdx

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: Schnellstart
3+
description: Generieren Sie einen MCP-Server, um Ihr Produkt mit LLMs zu verbinden
4+
---
5+
6+
## Einführung
7+
8+
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.
9+
10+
Mintlify ermöglicht es Ihnen, einen MCP-Server zu erstellen, der es KI-Tools erlaubt, in diesen wichtigen Szenarien mit Ihren Dokumenten zu interagieren:
11+
12+
1. **Docs Q\&A**, ähnlich wie unser KI-Chat. Dies ist automatisch für Ihre Dokumente aktiviert, keine Einrichtung erforderlich.
13+
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.
14+
15+
<Note>
16+
Durch Aktivierung des OpenAPI-Schalters erlauben Sie dem MCP-Server den Zugriff auf
17+
**alle**Endpunkte in Ihrer OpenAPI-Spezifikation.
18+
</Note>
19+
20+
## Installieren Sie den MCP-Server
21+
22+
<Tip>
23+
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.
24+
</Tip>
25+
26+
## Beispielinstallation mit dem Mintlify MCP-Server
27+
28+
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.
29+
30+
## Starten Sie den MCP-Server lokal
31+
32+
<Steps>
33+
<Step title="Install the server through the CLI">
34+
Führen Sie den folgenden Befehl aus, um den Server zu installieren:
35+
36+
```bash
37+
npx @mintlify/mcp add mintlify
38+
```
39+
</Step>
40+
41+
<Step title="Add the authentication token">
42+
Die folgende Antwort wird nach Ausführung des vorherigen Befehls angezeigt:
43+
44+
```
45+
> What is the Authorization (basic token)?
46+
```
47+
48+
Kopieren Sie mit Ihrem API-Chat-Schlüssel das Authentifizierungstoken und fügen Sie es in die CLI ein.
49+
</Step>
50+
51+
<Step title="Start your MCP server">
52+
Sie können jetzt ausführen:
53+
54+
```bash
55+
npm --prefix ~/.mcp/mintlify start
56+
```
57+
</Step>
58+
</Steps>
59+
60+
## Verwenden Sie Ihren Server mit Claude
61+
62+
<Note>
63+
Laden Sie die[Claude Desktop App](https://claude.ai/download)
64+
</Note>
65+
66+
Sobald Sie die Claude Desktop App installiert haben, folgen Sie diesen Schritten:
67+
68+
<Steps>
69+
<Step title="Navigate to the Settings > Developer" />
70+
71+
<Step title="Click on Edit Config">
72+
Fügen Sie Folgendes zu der`claude_desktop_config.json`hinzu:
73+
74+
```json
75+
{
76+
"mcpServers": {
77+
"mintlify": {
78+
"command": "npm",
79+
"args": [
80+
"--prefix",
81+
"~/.mcp/mintlify",
82+
"start"
83+
]
84+
}
85+
}
86+
}
87+
```
88+
</Step>
89+
90+
<Step title="If you see the hammer icon, you're all set!">
91+
Wenn Sie darauf klicken, sollten Sie die verfügbaren MCP-Tools in Ihrem Server sehen.
92+
93+
<Frame>
94+
![Claude MCP](/images/mcp-with-claude.png)
95+
</Frame>
96+
</Step>
97+
</Steps>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/topic
3+
---
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /chat/message
3+
---

de/advanced/rest-api/overview.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Überblick
3+
---
4+
5+
## Updates auslösen
6+
7+
Sie können die REST-API nutzen, um programmatisch ein Update auszulösen, wenn gewünscht.
8+
9+
<Info>
10+
Während der Hauptanwendungsfall das Auslösen von Updates sein wird, werden wir mit der Zeit mehr und mehr
11+
Funktionalität zur API hinzufügen. Lassen Sie uns wissen, was Sie sonst noch sehen möchten in
12+
[unserer Community](https://mintlify.com/community)!
13+
</Info>
14+
15+
## Authentifizierung
16+
17+
Sie können einen API-Schlüssel generieren über
18+
[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.
19+
20+
<Frame>
21+
<img src="/images/external-api-key.png" />
22+
</Frame>
23+
24+
## Admin-API-Schlüssel
25+
26+
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).
27+
28+
## Chat-API-Schlüssel
29+
30+
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.
31+
32+
Die Antworten enthalten Zitate, sodass Sie Ihre Benutzer zu den richtigen Stellen führen können, an denen sie Hilfe benötigen.
33+
34+
<Note>
35+
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.
36+
</Note>
37+
38+
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.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: GET /project/update-status/{statusId}
3+
---
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: POST /project/update/{projectId}
3+
---

de/advanced/subpath/cloudflare.mdx

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Cloudflare
3+
description: Hosten Sie Dokumentation unter einem /docs Unterpfad mit Cloudflare Workers
4+
---
5+
6+
## Cloudflare Worker erstellen
7+
8+
Navigieren Sie zu `Workers & Pages > Create application > Create worker`. Sie sollten den folgenden Bildschirm sehen, wo Sie einen neuen Cloudflare Worker erstellen können.
9+
10+
<Frame>
11+
<img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
12+
</Frame>
13+
14+
<Warning>
15+
Beachten Sie: Wenn Cloudflare Ihr DNS-Provider ist, sollten Sie kein Proxying für den CNAME-Eintrag verwenden
16+
</Warning>
17+
18+
### Benutzerdefinierte Domain hinzufügen
19+
20+
Sobald der Worker erstellt ist, klicken Sie auf `Configure worker`. Navigieren Sie zum Worker
21+
`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.`
22+
vor der Domain hinzuzufügen.
23+
24+
<Frame>
25+
<img alt="Cloudflare worker custom domain" src="/images/cloudflare/custom-domain.png" />
26+
</Frame>
27+
28+
Wenn Sie Probleme beim Einrichten eines benutzerdefinierten Unterverzeichnisses haben,
29+
[kontaktieren Sie unser Support-Team](mailto:[email protected]) und wir führen Sie durch den Prozess, Ihr Hosting bei uns zu aktualisieren.
30+
31+
### Worker-Skript bearbeiten
32+
33+
Klicken Sie auf `Edit Code` und fügen Sie das folgende Skript in den Code des Workers ein.
34+
35+
<Frame>
36+
<img alt="Cloudflare edit code" src="/images/cloudflare/edit-code.png" />
37+
</Frame>
38+
39+
<Tip>
40+
Bearbeiten Sie `DOCS_URL` indem Sie `[SUBDOMAIN]` durch Ihre eindeutige Subdomain ersetzen und`CUSTOM_URL` durch die Basis-URL Ihrer Website.
41+
</Tip>
42+
43+
```javascript
44+
addEventListener("fetch", (event) => {
45+
event.respondWith(handleRequest(event.request));
46+
});
47+
48+
async function handleRequest(request) {
49+
try {
50+
const urlObject = new URL(request.url);
51+
// If the request is to the docs subdirectory
52+
if (/^\/docs/.test(urlObject.pathname)) {
53+
// Then Proxy to Mintlify
54+
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
55+
const CUSTOM_URL = "[YOUR_DOMAIN]";
56+
57+
let url = new URL(request.url);
58+
url.hostname = DOCS_URL;
59+
60+
let proxyRequest = new Request(url, request);
61+
62+
proxyRequest.headers.set("Host", DOCS_URL);
63+
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
64+
proxyRequest.headers.set("X-Forwarded-Proto", "https");
65+
66+
return await fetch(proxyRequest);
67+
}
68+
} catch (error) {
69+
// if no action found, play the regular request
70+
return await fetch(request);
71+
}
72+
}
73+
```
74+
75+
Klicken Sie auf `Deploy` und warten Sie, bis die Änderungen übernommen wurden (dies kann bis zu einige Stunden dauern).

0 commit comments

Comments
 (0)