MMkDocs × Asyntai50 Nachrichten gratis

KI-Chatbot für MkDocsIhre Leser fragen. Ihre Doku antwortet.

Installation, Konfiguration, Fehler, API: Ihr KI-Assistent antwortet in Sekunden aus Ihrer Dokumentation. Sie installieren mkdocs-ai-chatbot mit pip und tragen das Plugin in die mkdocs.yml ein.

Kostenlos starten Zur Installation

Ohne Kreditkarte Mit Material for MkDocs Beim Build auf jeder Seite

docs.datenwerk.io/schnellstart

Datenwerk

Datenwerk API

Kostenlos bis 10.000 Anfragen

RESTPython-SDKWebhooks

API-Schlüssel holen

Datenwerk DocsOnline

Hallo! Wobei kann ich in der Doku helfen?

1Plugin für alle Seiten

24/7Antworten für Ihre Leser

0Änderungen an Ihrem Theme

50kostenlose Nachrichten zum Start

Was er beantwortet

Die Fragen, die Ihre Leser wirklich stellen

Gute Dokumentation hat viele Seiten. Leser suchen trotzdem oft die eine Antwort. Der Chatbot findet sie für sie, aus Ihrer eigenen Doku.

Wie fange ich an?Wie authentifiziere ich mich?Was bedeutet dieser Fehler?Welche Limits gibt es?Gibt es ein SDK?Wie richte ich Webhooks ein?

Was hat sich geändert?Wie mache ich ein Upgrade?Welche Optionen gibt es?Wie sicher ist das?Was kostet das?Wie erreiche ich den Support?

Funktionen

Gemacht für MkDocs-Dokumentationen

Für Software-Teams, Open-Source-Projekte und Firmen, die ihre Doku mit MkDocs bauen, auch mit Material for MkDocs und Read the Docs.

Er kennt Ihre Doku

Er liest Ihre veröffentlichten Seiten. Fügen Sie Dokumente wie Changelogs oder interne Handbücher sowie Fragen und Antworten hinzu.

Schnellstart5 Minuten

API-Referenz120 Endpunkte

Changelog.pdfVon der KI gelesen

Ein Plugin, kein Theme-Code

pip install, Eintrag in mkdocs.yml, bauen. Fertig.

1Plugin

Spricht die Sprache Ihrer Leser

Entwickler aus aller Welt: Er antwortet in der Sprache der Frage, auch wenn Ihre Doku nur auf Englisch oder Deutsch ist.

DEENESFRPTJA

Er sammelt Anfragen

Enterprise-Plan, Support-Vertrag, Demo: Er fragt nach der E-Mail-Adresse und speichert die Anfrage für Sie.

Felix N.Enterprise-Anfrage, 2 Mio. Anfragen

Neu

Desktop und Smartphone

Das Chatfenster passt sich jedem Bildschirm an, ohne Änderung an Ihrem Theme.

Sie sehen, was Leser suchen

Die Gespräche zeigen, welche Fragen immer wieder kommen. So wissen Sie, welche Seiten Ihrer Doku fehlen.

Schnellstart38%

Fehler26%

Limits17%

Nur Ihre Inhalte

Die KI antwortet aus Ihrer Doku und Ihren Dokumenten. Sie erfindet keine Funktionen, Parameter oder Zusagen und beantwortet keine fachfremden Fragen.

Schreibst du mir ein Gedicht?Ich beantworte nur Fragen zur Datenwerk-Doku. Darf ich Ihnen den Schnellstart zeigen?

In Aktion

Ein Assistent, der Ihre Doku kennt

Er antwortet aus Ihren Seiten, zeigt die passende Stelle und erscheint in den Farben Ihrer Marke.

Antworten aus Ihrer Doku
Anleitungen, Referenz, Fehlercodes: Er nutzt Ihre eigenen Seiten und erfindet nichts.
Er zeigt den nächsten Schritt
Er zeigt passende Seiten oder Angebote als Karten, mit Link.
Er leitet Anfragen weiter
Für Enterprise oder Support-Verträge fragt er nach der E-Mail-Adresse.

Probieren Sie eine Farbe

Installation

Einfache Installation in MkDocs

Asyntai hat ein eigenes Plugin für MkDocs. Beim Build setzt es den Chat auf jede Seite, auch auf die 404-Seite.

Widget-ID kopieren

Erstellen Sie ein kostenloses Asyntai-Konto und öffnen Sie die Seite Install. Ihre Widget-ID steht im Code bei data-asyntai-id und beginnt mit asyntai_.

Plugin installieren

Führen Sie pip install mkdocs-ai-chatbot aus.

Plugin eintragen

Tragen Sie das Plugin mit Ihrer Widget-ID in die mkdocs.yml unter plugins ein, wie im Beispiel. Lassen Sie search in der Liste, wenn Sie die Suche nutzen.

Bauen und veröffentlichen

Führen Sie mkdocs build oder mkdocs gh-deploy aus. Die Chat-Blase erscheint auf jeder Seite unten in der Ecke.

Hat die mkdocs.yml einen Abschnitt plugins, lädt MkDocs nur die Plugins, die dort stehen. Fehlt die Widget-ID, stoppt der Build mit einem Hinweis zur Lösung.

Ihr Projekt mkdocs.yml

mkdocs.yml

Paket

mkdocs-ai-chatbot

Konfiguration

plugins: - search - asyntai: widget_id: asyntai_IHRE_ID

mkdocs build

Warum Asyntai

Was MkDocs-Dokumentationen davon haben

Starten Sie kostenlos mit 50 Nachrichten und wachsen Sie mit Ihrem Projekt.

Preise ansehen Kostenlos starten

Weniger Support-Tickets

Fragen, die Ihre Doku schon beantwortet, beantwortet der Chatbot direkt. Ihr Team hat mehr Zeit.

Leser finden schneller

Statt zu suchen, fragen Leser einfach. Der Chatbot antwortet aus Ihren Seiten.

Hilfe auch auf der 404-Seite

Landet ein Leser auf einem kaputten Link, kann er trotzdem fragen und findet weiter.

FAQ

Häufige Fragen

Alles, was Sie wissen müssen, um Ihrer MkDocs-Dokumentation einen KI-Chatbot hinzuzufügen.

Wie installiere ich den Chatbot in MkDocs?

Führen Sie pip install mkdocs-ai-chatbot aus und tragen Sie das Plugin mit Ihrer Widget-ID in die mkdocs.yml unter plugins ein. Bauen Sie dann die Doku mit mkdocs build.

Funktioniert das mit Material for MkDocs?

Ja. Das Plugin funktioniert mit jedem MkDocs-Theme, auch mit Material for MkDocs und Read the Docs.

Warum ist meine Suche weg?

Hat die mkdocs.yml einen Abschnitt plugins, lädt MkDocs nur die Plugins, die dort stehen. Lassen Sie search deshalb in der Liste.

Welche MkDocs-Versionen werden unterstützt?

Das Plugin funktioniert mit MkDocs 1.4 und neuer.

Kann ich den Chat lokal ausschalten?

Ja. Mit enable_on_serve: false erscheint der Chat nicht bei mkdocs serve, sondern nur auf der gebauten Doku.

Woher kennt der Chatbot meine Doku?

Asyntai liest Ihre veröffentlichten Seiten. Geben Sie die Adresse Ihrer Doku im Dashboard ein. Zusätzlich können Sie Dokumente sowie Fragen und Antworten hinzufügen.

Antwortet der Chatbot auch in anderen Sprachen?

Ja. Er erkennt die Sprache der Frage und antwortet automatisch in dieser Sprache.

Was kostet das Plugin?

Das Plugin ist kostenlos. Bei Asyntai starten Sie mit kostenlosen Nachrichten und wechseln bei Bedarf in einen größeren Plan.

Ratgeber

Wie ein KI-Chatbot MkDocs-Dokumentationen hilft

Gute Doku, trotzdem Fragen

MkDocs ist beliebt für Software-Dokumentationen. Doch je mehr Seiten eine Doku hat, desto schwerer finden Leser die eine Antwort, die sie brauchen.

Ein KI-Chatbot beantwortet ihre Frage direkt, mit Ihren eigenen Seiten als Quelle.

Ein Plugin statt Theme-Arbeit

Das Plugin mkdocs-ai-chatbot setzt den Chat beim Build auf jede Seite. Sie ändern weder Theme noch Overrides.

Es funktioniert mit Material for MkDocs, Read the Docs und jedem anderen Theme.

Weniger Tickets, zufriedenere Entwickler

Viele Support-Tickets betreffen Dinge, die schon in der Doku stehen. Der Chatbot beantwortet sie sofort, rund um die Uhr.

So hat Ihr Team mehr Zeit für echte Probleme.

Leser aus aller Welt

Der Chatbot erkennt die Sprache der Frage und antwortet automatisch in dieser Sprache.

So helfen Sie auch Entwicklern, deren Sprache Ihre Doku nicht abdeckt.

Gespräche zeigen, was Ihrer Doku fehlt

Jedes Gespräch wird gespeichert und ist im Dashboard durchsuchbar. Nach einigen Wochen sehen Sie, welche Fragen am häufigsten kommen.

Mit diesen Hinweisen schreiben Sie genau die Seiten, die Ihren Lesern noch fehlen.

Bereit für einen KI-Assistenten in Ihrer MkDocs-Doku?

Starten Sie kostenlos mit 50 Nachrichten und sehen Sie, welche Fragen Ihre Leser jeden Tag stellen.

Kostenlos starten Preise ansehen

Andere Plattformen

docsify DokuWiki Flarum Typemill Starlight Jekyll Eleventy Astro Next.js Gatsby Wagtail Alle CMS-Plattformen