Smart Mermaid: KI-Tool zur schnellen Erstellung von Flussdiagrammen und Zeitdiagrammen mit Text

Smart Mermaid ist eine quelloffene, KI-gesteuerte Webanwendung, die sich auf die Umwandlung von Text in natürlicher Sprache, der von Nutzern eingegeben wird, in Mermaid-formatierten Code und die Erstellung visueller Diagramme konzentriert. Sie vereinfacht den Diagrammprozess durch KI-Technologie und macht das manuelle Schreiben von komplexem Code überflüssig. Benutzer müssen nur einfachen Text verwenden, um den Geschäftsprozess oder die Logik zu beschreiben. Smart Mermaid kann auf intelligente Weise Flussdiagramme, Zeitdiagramme, Klassendiagramme und andere verschiedene Diagramme analysieren und erzeugen. Das Projekt unterstützt die Docker-Ein-Klick-Bereitstellung und eignet sich für Entwickler, Produktmanager und Personen, die schnell professionelle Diagramme erstellen müssen. Der Code wird auf GitHub gehostet, mit 810 Sternen und 92 Zweigen, was die aktive Unterstützung der Community zeigt.

Funktionsliste

• Mit natürlicher Sprache erstellte DiagrammeDer Benutzer gibt eine Textbeschreibung ein, und AI analysiert und generiert automatisch den Kartencode im Mermaid-Format.
• Unterstützung für mehrere DiagrammtypenUmfasst Flussdiagramme, Zeitdiagramme, Klassendiagramme, Gantt-Diagramme und Architekturdiagramme, die gängige Geschäftsszenarien abdecken.
• Benutzerdefinierte AI-KonfigurationUnterstützung bei der Konfiguration von KI-Diensten, wie API-Adressen und -Schlüssel, um individuellen Anforderungen gerecht zu werden.
• Professioneller Chart-EditorBearbeiten und Vorschauen und Unterstützung mehrerer Rendering-Modi, um die Professionalität von Diagrammen zu erhöhen.
• Docker-Bereitstellung mit einem KlickSchnelles Erstellen von lokalen oder Server-Umgebungen mit Docker für eine einfache Nutzung.
• ZugangskontrolleUnterstützung für das Festlegen von Zugangskennwörtern zum Schutz der vom Benutzer erstellten Inhalte.

Hilfe verwenden

Einbauverfahren

Smart Mermaid unterstützt die schnelle Bereitstellung über Docker, hier sind die detaillierten Installationsschritte:

1. Code-Repository klonen
   Führen Sie den folgenden Befehl im Terminal aus, um das Projekt lokal zu klonen:

   git clone https://github.com/liujuntao123/smart-mermaid.git
   cd smart-mermaid
   

2. Wechseln zu einer Docker-Verzweigung
   Hinweis: Der Master-Zweig enthält nicht die Docker-Konfigurationsdatei und Sie müssen zum docker Verzweigung:

   git checkout docker
   

3. Konfigurieren von AI-Diensten
   Smart Mermaid ist auf externe KI-Dienste wie die OpenAI API angewiesen, um Text zu analysieren. Die folgenden Umgebungsvariablen müssen konfiguriert werden:
   • Compiler docker-compose.yml oder der Umgebungsvariablendatei Folgendes hinzu:

     AI_API_URL=https://api.openai.com/v1
     AI_API_KEY=你的API密钥
     AI_MODEL_NAME=gpt-3.5-turbo
     

   • Wenn eine Zugangskontrolle erforderlich ist, legen Sie diese fest:

     ACCESS_PASSWORD=你的访问密码
     

4. Neue Dienste
   Starten Sie den Dienst mit Docker Compose:

   docker-compose up -d
   

   Wenn der Dienst startet, wird Smart Mermaid lokal ausgeführt http://localhost:3000.

5. Zugang zu Anwendungen
   Öffnen Sie Ihren Browser und besuchen Sie http://localhost:3000. Wenn ein Zugangspasswort festgelegt wurde, geben Sie das Passwort ein, um auf den Betriebsbildschirm zuzugreifen.

Hauptfunktionen

1. die Erstellung von Diagrammen

• Verfahren::
  1. Geben Sie in das Texteingabefeld auf der Startseite einen Text in natürlicher Sprache ein, der den Geschäftsprozess beschreibt. Zum Beispiel: "Der Benutzer meldet sich beim System an, das System überprüft seine Identität, und bei Erfolg gelangt er zur Startseite, bei Misserfolg wird ihm eine Fehlermeldung angezeigt."
  2. Klicken Sie auf die Schaltfläche "Generieren" und die KI wird den Text analysieren und den entsprechenden Mermaid-Code generieren.
  3. Das System wählt automatisch den passenden Diagrammtyp aus (z. B. Flussdiagramm oder Zeitdiagramm) oder Sie können den Typ manuell angeben.
  4. Die erzeugten Diagramme werden im rechten Vorschaubereich angezeigt und können in Echtzeit angepasst werden.
• caveat::
  • Geben Sie den Text so klar wie möglich ein, beschreiben Sie logische Zusammenhänge und vermeiden Sie vage Aussagen.
  • Unterstützt die Eingabe von bis zu 20.000 Zeichen, mit einem Limit von 5 Generierungen pro Tag (konfigurierbar über ein Profil) NEXT_PUBLIC_DAILY_USAGE_LIMIT (Geändert).

2. bearbeiten und exportieren

• Tabelle bearbeiten::
  • Sie können den Mermaid-Code direkt ändern, indem Sie auf die Schaltfläche "Bearbeiten" im Vorschaubereich klicken.
  • Nach der Anpassung des Codes werden die Diagramme zur schnellen Fehlersuche in Echtzeit aktualisiert.
• Diagramme exportieren::
  • Unterstützung für den Export von Diagrammen in SVG-, PNG- oder Mermaid-Code-Dateien.
  • Klicken Sie auf die Schaltfläche "Exportieren", wählen Sie das Format und laden Sie es lokal herunter.
• Rendering-Modus::
  • Unterstützt mehrere Rendering-Modi (z. B. dunkle oder helle Themen), die in den Einstellungen umgeschaltet werden können.

3. benutzerdefinierte Konfiguration

• AI-Dienst-Konfiguration::
  • existieren docker-compose.yml Änderung AI_API_URL im Gesang antworten AI_API_KEYunterstützt den Zugang zu anderen KI-Diensten (z. B. lokal installierte Modelle).
  • einstellbar AI_MODEL_NAME Verwenden Sie verschiedene Modelle, um die Erzeugung zu optimieren.
• Zugangsbeschränkung::
  • aufstellen ACCESS_PASSWORD Danach können nur Benutzer, die das richtige Kennwort eingeben, auf die Anwendung zugreifen, die für den internen Gebrauch im Team geeignet ist.

4. die Historie ansehen

• Die erstellten Diagramme werden in der lokalen Sitzung gespeichert, und Sie können die zuvor erstellten Diagramme anzeigen, indem Sie auf "Verlauf" klicken.
• Unterstützt die erneute Bearbeitung oder das Löschen von historischen Diagrammen zur einfachen Verwaltung.

Häufig gestellte Fragen

• AI-Parse-Fehler: Inspektion AI_API_KEY ob sie gültig ist, und stellen Sie sicher, dass die Netzwerkverbindung funktioniert.
• Fehler beim Docker-StartBestätigt, dass Sie zu docker Zweigstelle, Prüfung docker-compose.yml Die Konfiguration ist korrekt.
• Anomalie in der KartenanzeigeMermaid-Code: Stellen Sie sicher, dass Sie syntaktisch korrekten Mermaid-Code eingeben, indem Sie sich auf die offizielle Mermaid-Dokumentation beziehen (https://mermaid.js.org).

Anwendungsszenario

1. Produktmanager entwerfen Geschäftsprozesse
   Produktmanager müssen schnell Flussdiagramme oder Zeitdiagramme erstellen, um die Geschäftslogik zu beschreiben. Smart Mermaid ermöglicht es ihnen, Anforderungen in natürlicher Sprache einzugeben und schnell professionelle Diagramme zu erstellen, die Zeit sparen.
2. Dokumentation für Entwickler
   Bei der Erstellung technischer Dokumentation können Entwickler mit Smart Mermaid schnell Architektur- oder Klassendiagramme erstellen, die in Markdown-Dateien eingebettet werden können, um die Lesbarkeit zu verbessern.
3. Teamarbeit und Präsentation
   Wenn Teams ein Projekt besprechen, können sie mit Smart Mermaid Diagramme und Grafiken zur Verwendung in PPTs oder Online-Präsentationen erstellen und exportieren, was die Kommunikation erleichtert.
4. Bildung und Ausbildung
   Lehrer oder Ausbilder können Smart Mermaid verwenden, um komplexe logische Zusammenhänge in visuelle Diagramme zu verwandeln, die den Schülern das Verständnis erleichtern.

QA

1. Welche Diagrammtypen werden von Smart Mermaid unterstützt?
   Unterstützt Flussdiagramme, Zeitdiagramme, Klassendiagramme, Gantt-Diagramme und Architekturdiagramme, die die meisten Geschäftsszenarien abdecken.
2. Wie kann ich sicherstellen, dass die von AI erstellten Diagramme korrekt sind?
   Geben Sie Klartextbeschreibungen ein, um logische Beziehungen zu verdeutlichen. Nach der Erstellung können Sie den Mermaid-Code manuell bearbeiten, um sicherzustellen, dass das Diagramm Ihren Anforderungen entspricht.
3. Ist Programmiererfahrung erforderlich?
   Smart Mermaid erstellt Diagramme in natürlicher Sprache und ist für Nicht-Programmierer geeignet. Entwickler können den Code weiter bearbeiten, um ihn zu optimieren.
4. Welche Voraussetzungen sind für den Einsatz von Docker erforderlich?
   Git und Docker Compose müssen installiert werden, um den Netzwerkzugang zu KI-Diensten (z. B. OpenAI API) sicherzustellen.