GitBook ist eine Plattform, die es Ihnen und Ihrem Team ermöglicht, Dokumentationsseiten zu erstellen und zusammenzuarbeiten. GitBook tut dies, indem es Versionskontrollkonzepte wie Verzweigung und Zusammenführung verwendet.

Da viele Teammitglieder an einer einzigen Dokumentationsseite arbeiten können, ermöglicht Ihnen GitBook, separate Entwürfe zu erstellen und zu verwalten. Sie können auch die Unterschiede zwischen Ihrem aktuellen Entwurf und der Master-Dokumentationskopie anzeigen.

Es stehen Ihnen mehrere Arten von Blöcken zur Verfügung, die Sie zu Ihren Wiki-Seiten hinzufügen können. Dazu gehören Überschriften, Absätze, Bilder, Hinweise, Tabellen, Codeblöcke, Dateianhänge und mehr.

So fügen Sie Inhaltsblöcke in GitBook hinzu

Sie können eine Liste der verfügbaren Inhaltsblöcke anzeigen, die einer Seite hinzugefügt werden können. Sie können dies tun, indem Sie irgendwo auf die Seite klicken und auf klicken Plus Symbol, das erscheint. Sie können auch direkt nach einem bestimmten Inhaltsblock suchen.

instagram viewer

Sie können Inhalte mit Markdown hinzufügen. Wenn Sie Markdown noch nicht verwendet haben, können Sie mehr darüber erfahren wie Sie mit Markdown beginnen. Sie können auch mehr darüber lesen warum Markdown so beliebt ist.

So fügen Sie Absätze, Listen, Zitate oder Codeblöcke hinzu

Um Listen, Absätze, Zitate, Codeblöcke oder andere einfache Inhaltsblöcke hinzuzufügen, öffnen Sie das Dropdown-Menü und wählen Sie aus den verfügbaren Typen aus.

  1. Klicken Sie auf einer Seite Ihrer Dokumentationssite auf die Plus Schaltfläche an der Stelle, an der Sie Ihren Inhalt hinzufügen möchten.
  2. Über das Dropdown-Menü können Sie durch die Liste blättern, um die verschiedenen Inhaltsoptionen anzuzeigen.
  3. Wählen Sie hier einen beliebigen einfachen Inhaltstyp aus, z. B. einen Absatz, einen Codeblock, eine Überschrift oder ein Zitat. GitBook passt den Inhalt automatisch an das von Ihnen ausgewählte Format an.

So fügen Sie Bilder oder Dateianhänge hinzu

Um Bilder hinzuzufügen, verwenden Sie das Dropdown-Menü, um die auszuwählen Bilder Inhaltsblock-Option. Um Dateien hinzuzufügen, wählen Sie die Dateien einfügen Option statt. Sie können dann das rechte Bedienfeld verwenden, um Ihre hochgeladenen Bilder und Dateien zu verwalten.

  1. Öffnen Sie eine Seite auf Ihrer Dokumentationswebsite. Klick auf das Plus Schaltfläche, um das Dropdown-Menü für verfügbare Inhaltsblöcke zu öffnen.
  2. Auswählen Bilder einfügen.
  3. Im angezeigten rechten Bereich befinden sich drei Registerkarten. Das Dateien Auf der Registerkarte können Sie Ihre eigene Bilddatei hochladen. Das URL Mit der Registerkarte können Sie online auf ein Bild verlinken. Sie können auch die öffnen Unsplash Tab. Hier können Sie vorhandene Fotos auswählen, die keine Zuordnung erfordern.
  4. Nachdem Sie ein Bild hinzugefügt haben, klicken Sie auf das drei Punkte Schaltfläche befindet sich in der oberen linken Ecke des Bildes. Dadurch wird ein Dropdown-Menü geöffnet, in dem Sie das Bild ausrichten oder löschen können. Sie können dem Bild auch eine Bildunterschrift geben.
  5. Um Dateien einzufügen, platzieren Sie Ihren Cursor irgendwo auf einer Seite Ihrer Dokumentations-Site. Klick auf das Plus Schaltfläche, um das Dropdown-Menü für Inhaltsblocktypen zu öffnen. Klicken Sie diesmal auf die Dateien einfügen Möglichkeit.
  6. Auf der rechten Seite wird ein ähnliches Fenster angezeigt, in dem Sie anstelle eines Bildes einen beliebigen Dateianhang hochladen können. Klicke auf Dateien durchsuchen um eine lokal auf Ihrem Computer gespeicherte Datei auszuwählen.
  7. Die Datei wird in der Liste angezeigt. Klicken Sie auf die Datei, und GitBook erstellt einen Inhaltsblock mit dem Dateianhang auf der Seite, die Sie geöffnet haben. Durch Klicken auf diesen Inhaltsblock wird der Dateianhang heruntergeladen.

So fügen Sie Hinweise hinzu

Sie können Ihrer Seite auch Hinweise hinzufügen. Sie können das Symbol für die Hinweise so ändern, dass es rot für Gefahr, orange für Warnung, blau für Informationen oder grün für Erfolg verwendet wird.

  1. Um einen Hinweis hinzuzufügen, klicken Sie auf das Plus Schaltfläche, um das Dropdown-Menü für verfügbare Inhaltsblöcke zu öffnen.
  2. Auswählen Hinweis.
  3. Dadurch wird Ihrer Seite ein Hinweis hinzugefügt. Standardmäßig ist der Hinweistyp „Information“ und enthält ein blaues Symbol.
  4. Sie können den Hinweistyp ändern, indem Sie auf das Symbol klicken. Dadurch werden die vier verschiedenen Hinweistypen durchlaufen.

So fügen Sie Tabellen hinzu

Sie können Tabellen hinzufügen, indem Sie auswählen Tisch Option aus der Dropdown-Liste. Sobald Sie die Tabelle auf der Seite haben, können Sie neue Zeilen oder Spalten hinzufügen. Sie können auch die Namen und Datentypen der Spalten ändern und die Daten in der Tabelle ändern.

  1. Klick auf das Plus Schaltfläche, um das Dropdown-Menü für verfügbare Inhaltsblöcke zu öffnen.
  2. Auswählen Tisch.
  3. Klicken Sie auf die Überschrift einer Spalte in der Tabelle. Dies öffnet ein neues kleineres Menü, in dem Sie den Namen der ausgewählten Spalte ändern können. In diesem Menü können Sie auch die ausgewählte Spalte löschen oder ausblenden. Bei bestimmten Spaltendatentypen können Sie den Inhalt auch innerhalb der Spalte ausrichten.
  4. Standardmäßig ist der ausgewählte Datentyp für die Spalten „Text“. Klicken Sie auf die Schaltfläche mit dem T Symbol, um den Datentyp zu ändern. Sie können es in eine Zahl, ein Kontrollkästchen, ein Dropdown-Menü, einen Dateianhang, eine Bewertung oder mehr ändern.
  5. Klick auf das Symbol mit sechs Punkten in der Nähe der oberen linken Ecke der Tabelle. Hier können Sie neue Spalten und Zeilen einfügen oder die gesamte Tabelle löschen. Sie können auch bestimmte Spalten ein- oder ausblenden oder andere Eigenschaften der Tabelle ändern.

So fügen Sie Seiten-Link-Blöcke hinzu

Seitenlinkblöcke sind Links, die die gesamte Zeile auf der Seite einnehmen. Wenn Sie den Link hinzufügen, müssen Sie auf die Seite verlinken, die geöffnet wird, wenn jemand darauf klickt.

  1. Klick auf das Plus Schaltfläche, um das Dropdown-Menü für verfügbare Inhaltsblöcke zu öffnen.
  2. Klicke auf Seitenlink.
  3. Wählen Sie aus dem neuen Dropdown-Menü die Seite aus, auf die Sie verlinken.
  4. Ihr Seitenlink wird in einem Block auf der Seite angezeigt.

Verwenden von GitBook für die Dokumentation

GitBook ist ein Dokumentationstool, das Versionskontrollkonzepte wie Verzweigung und Zusammenführung verwendet. Dadurch können mehrere Teammitglieder gleichzeitig an der Dokumentation arbeiten. Es hilft auch, auftretende Konflikte zu bewältigen.

Sie können einer Seite alle Arten von Inhaltsblöcken hinzufügen. Sie können Überschriften, Absätze, Codeblöcke oder Aufzählungszeichen verwenden, um Ihre Inhalte neu zu formatieren. Sie können den Hinweistyp, die Meldung und den Symboltyp von Hinweisen ändern sowie die Spalten einer Tabelle anpassen.

Auf der Registerkarte Dateien können Sie Bilder und Dateianhänge verwalten, die Sie auf die Site hochladen. Mit Seitenlinks können Sie große Links erstellen, die Benutzer leicht erkennen können.

Wenn Sie Dokumentation zur Go-Sprache erstellen, können Sie Godoc verwenden. Mit Godoc können Sie Ihren Go-Code automatisch dokumentieren.