Beiträge zur Dokumentation sind willkommen! Dieser Leitfaden erklärt, wie Sie zur LibreChat-Dokumentation beitragen können, indem Sie neue Dokumentationen schreiben und formatieren. Die Website wurde mit Fumadocs erstellt und die Dokumentation verwendet das .mdx-Format.

Wann man eine Dokumentation statt eines Blogbeitrags schreibt

Erste Schritte

• Forken Sie das LibreChat Dokumentations-Repository: https://github.com/LibreChat-AI/librechat.ai

• Erstellen Sie einen Branch auf Ihrem Fork, benennen Sie ihn angemessen und verknüpfen Sie ihn mit dem ursprünglichen Repository.

git clone -b branch-name https://github.com/username/librechat.ai.git

Ersetzen Sie branch-name und username durch Ihre Details

Neue Dokumente erstellen

Um ein neues Dokument zu erstellen:

• Verwenden Sie die Dateiendung .mdx (siehe MDX-Dokumentation für weitere Informationen).
• Benennen Sie Dateien mit Kleinbuchstaben und Unterstrichen (z. B. documentation_guidelines.mdx).
• Legen Sie neue Dokumente im entsprechenden Ordner/Unterordner unter content/docs ab.
• Fügen Sie das Dokument zum pages-Array in der meta.json-Datei des Ordners hinzu, in dem sich Ihr Dokument befindet. Wenn Sie es nicht hinzufügen, kann Fumadocs es zwar weiterhin finden, es wird jedoch nicht in der beabsichtigten Reihenfolge in der Seitenleiste erscheinen.

Richtlinien zur Markdown-Formatierung

• Verwenden von Überschriften und Unterüberschriften mit #, ## und ###.

  • Verwenden Sie # für den Dokumenttitel (es ist nur ein Haupttitel pro Dokument zulässig).
  • Verwenden Sie ## für Hauptabschnitte.
  • Verwenden Sie ### für Unterabschnitte innerhalb eines Abschnitts.
• Verwenden Sie **, um Text fett zu drucken und wichtige Informationen hervorzuheben (verwenden Sie dies nicht anstelle einer Überschrift).
• Verwenden Sie URL-Pfade, um auf andere Dokumente zu verlinken (z. B. zeigt /docs/documentation auf das aktuelle Dokument).
• Sie können HTML, TS und JS verwenden, um einem Dokument zusätzliche Funktionen hinzuzufügen.
• Stellen Sie sicher, dass jedes HTML-Element über schließende Tags verfügt (z. B. <img src="" /> oder <a href="link"></a>).
• Verwenden Sie keine HTML-Kommentare; nutzen Sie stattdessen Markdown-Kommentare, nur wenn der Text tatsächlich ausgeblendet werden soll.

Dokumentationsressourcen

Dokumenten-Metadaten

Fügen Sie Ihrem Dokument Metadaten im Header unter Verwendung des folgenden Formats hinzu:

Hinweis: Das Feld ogImage ist optional und kann vollständig weggelassen werden. Es wird verwendet, um das Bild festzulegen, das beim Teilen Ihres Dokuments auf Social-Media-Plattformen angezeigt wird.

---
title: Document Title
description: This description will be used in social cards and search engine results.
ogImage: /images/docs/<category>/image.png (optional)
---

Assets

Lade Assets (z. B. Bilder) nach Möglichkeit auf GitHub hoch, anstatt sie im Ordner /public zu speichern. Dies trägt dazu bei, dein Repository organisiert zu halten und erleichtert die Verwaltung deiner Assets.

Bilder

Verwenden Sie für Screenshots, die sich an das aktive Theme anpassen sollen, die ThemeImage Komponente. Geben Sie eine light und eine dark Quelle an, und sie rendert die Variante, die dem Theme des Lesers entspricht. Sie unterstützt außerdem, wie jedes andere Bild auch, die Zoom-Funktion bei Klick.

sehen Sie sich das folgende Beispiel hier in Aktion an: Benutzerhandbücher

<ThemeImage
  light="https://github.com/danny-avila/LibreChat/assets/32828263/cf0f3231-287a-407f-bd4d-3d5bad94e893"
  dark="https://github.com/danny-avila/LibreChat/assets/32828263/a03ee02d-5099-4220-95b0-bfa2d3b00b4d"
  alt="LibreChat running on an iPad"
/>

So laden Sie Bilder und Videos auf GitHub hoch

Testen der Dokumentation