So erstellen Sie ein einfaches internes Wiki mit Gitbook

GitBook ist eine Plattform, mit der Sie Dokumentationsseiten oder Firmenwikis erstellen können. Sie können es verwenden, um alle möglichen Dinge zu dokumentieren, von Code bis hin zu APIs und der Verwendung eines Softwareprodukts.

GitBook verwendet einen ähnlichen Prozess wie GitHub-Repositories. Die Hauptkopie der Dokumentation fungiert als „Master“-Kopie. Sie können dann „Entwürfe“ erstellen, die „Zweigen“ ähneln.

Dieser Prozess ermöglicht es vielen Benutzern, an einer einzigen Dokumentationssite zu arbeiten und gleichzeitig Konflikte zu behandeln oder zu verhindern. Es ermöglicht auch, dass Änderungen aus verschiedenen Branches einen Überprüfungsprozess durchlaufen, bevor Sie sie zusammenführen.

So beginnen Sie mit der Verwendung von GitBook

Sie können aus mehreren wählen GitBook-Preise Pläne. Die Preise hängen davon ab, ob Sie GitBook für Open-Source-Projekte, den persönlichen Gebrauch oder die Zusammenarbeit im privaten Team verwenden. GitBook kann kostenlos verwendet werden, wenn Sie es für Open-Source-Projekte verwenden.

GitBook unterstützt Markdown, eine beliebte Auszeichnungssprache mit vielen Vorteilen zum Schreiben oder Dokumentieren im Web.

GitBook lässt sich auch mit integrieren GitHub, eine Plattform zum Hosten, Speichern und Bearbeiten von Code. Sie können Ihr GitBook-Konto direkt mit Ihrem GitHub-Konto verknüpfen, indem Sie sich mit Ihren GitHub-Anmeldeinformationen anmelden.

1. Melden Sie sich bei GitBook an. Wenn Sie über ein eigenes GitHub-Konto verfügen, können Sie auf klicken Melden Sie sich bei GitHub an.
2. Sobald Sie sich angemeldet haben, leitet GitBook Sie zu einem neuen internen Wiki weiter. Außerdem wird Ihr Wiki mit einigen Beispielinhalten vorbelegt.

Ein Überblick über die GitBook-Oberfläche

GitBook verfügt über mehrere Funktionen, mit denen Sie Ihre Dokumentationsseite erstellen und ändern können.

1. Im oberen Bereich können Sie neue Entwürfe erstellen, den Änderungsverlauf anzeigen oder andere Diskussionen oder Anhänge anzeigen.
2. In der Seitenleiste ganz links können Sie mehrere Bereiche erstellen. Sie können separate Bereiche für verschiedene Projekte verwenden, um Ihre Dokumentationsbereiche zu trennen und zu organisieren. Sie können die Seitenleiste erweitern oder schließen.
3. Der linke Bereich fungiert als Menü für die Dokumentationsseite. Sie können die Seiten innerhalb Ihrer Dokumentationssite anzeigen und sie zum Erstellen von Gruppen und verschachtelten Seiten verwenden. Sie können auch über die angegebenen Links auf der Website navigieren.
4. Das untere Bedienfeld enthält Schaltflächen, die für den Versionskontrollprozess von entscheidender Bedeutung sind. Sie können einen Namen für Ihren Entwurf hinzufügen, eine Änderung zusammenführen oder die Änderung zur Überprüfung einreichen.

So erstellen Sie einen neuen Entwurf

Sie können einen neuen Entwurf erstellen, indem Sie eine neue Änderungsanforderung erstellen und darin Änderungen vornehmen.

1. Klicken Sie im oberen Bereich auf Änderungswünsche.
2. Klicken Sie im neuen Bedienfeld, das auf der rechten Seite angezeigt wird, auf Entwurf Tab. Dies zeigt Ihnen alle Ihre aktiven Entwürfe.
3. Von hier aus können Sie auf einen vorhandenen Entwurf klicken, um ihn zu öffnen. Um einen neuen Entwurf zu erstellen, klicken Sie auf Neuer Änderungswunsch, und warten Sie, bis die Seite vollständig geladen ist.
4. Klicken Sie im unteren Bereich auf Geben Sie einen Betreff ein. Es öffnet sich ein Fenster, in dem Sie dem neuen Entwurf einen Namen geben können. Zum Beispiel, Neue Seite - So richten Sie die Codebasis ein.

So erstellen Sie Seiten und Gruppen

Sobald Sie einen Entwurf haben, können Sie damit beginnen, Änderungen an der Dokumentation vorzunehmen. GitBook speichert Ihre Änderungen innerhalb des Entwurfs, sodass sie sich nicht auf die Masterkopie auswirken. Über die linke Seitenleiste können Sie Seiten und Seitengruppen hinzufügen.

1. Erstellen Sie eine neue Seite, indem Sie auf klicken Neue Seite Link unten in der Seitenleiste und auswählen Neue Dokumentenseite aus der Dropdown-Liste. Alternativ können Sie den Mauszeiger unter eine vorhandene Seite bewegen und auf das Blau klicken Plus Taste.
2. Um eine neue Seitengruppe zu erstellen, klicken Sie auf Neue Seite, und wählen Sie die aus Neue Gruppe Option aus der Dropdown-Liste.
3. Sie können die Seite umbenennen, indem Sie auf die drei Punkte neben der Seite oder Gruppe klicken und auswählen Umbenennen.
4. Beginnen Sie mit dem Hinzufügen von Inhalten, um Ihre neue Seite zu füllen. Sie können einfache Inhalte wie Text oder Überschriften hinzufügen. Mit GitBook können Sie auch andere Inhaltsblöcke wie Bilder, Dateianhänge, Tabellen, Registerkarten oder Codeschnipsel hinzufügen. Es besteht auch die Möglichkeit, andere Integrationen wie YouTube-Einbettungen oder Google Docs-Inhalte hinzuzufügen.
5. Klick auf das Diff-Ansicht Schaltfläche im unteren Bereich, um die Unterschiede zwischen Ihrem Entwurf und der ursprünglichen Master-Dokumentationskopie anzuzeigen.
6. Wenn Sie mit dem Schreiben Ihrer Inhalte fertig sind, können Sie auf klicken Verschmelzen, Senden und zusammenführen, oder Zur Überprüfung einreichen.

Sie können über den oberen Bereich von GitBook auf den Freigabelink zugreifen. Sie müssen sich außerhalb eines Entwurfs befinden und die Kopie der Masterdokumentation anzeigen, um den Link anzeigen zu können.

1. Standardmäßig ist die Sichtbarkeit Ihrer Dokumentationsseite „nicht gelistet“. Das bedeutet, dass Sie über einen privaten Link und nicht über Suchmaschinen auf die Dokumentationsseite zugreifen können. Klicken Sie im oberen Bereich auf die Nicht gelistet Taste.
2. Wählen Sie Ihre gewünschten Sichtbarkeitseinstellungen aus der Dropdown-Liste aus. Beachten Sie, dass GitBook möglicherweise bestimmte Sichtbarkeitseinstellungen sperrt und Sie möglicherweise ein Upgrade durchführen müssen, um darauf zugreifen zu können.
3. Unter der Liste der Sichtbarkeitseinstellungen befindet sich ein Link, den Sie mit anderen Benutzern teilen können, die Ihre Dokumentationssite verwenden werden. Kopieren Sie diesen Link, um ihn mit anderen zu teilen.
4. Klicken Sie unter dem Link auf Link- und Domain-Einstellungen. Hier können Sie einen benutzerdefinierten Domänennamen verknüpfen oder einen Teil der URL ändern. Wenn Sie eine benutzerdefinierte Domäne verwenden, können Sie anzeigen Gitbook-Dokumentation wie Sie Ihr DNS richtig konfigurieren.

Dokumentation mit GitBook erstellen

Mit GitBook können Sie gemeinsam Dokumentationsseiten oder Firmenwikis erstellen und bearbeiten. GitBook leiht sich Konzepte von GitHub wie Verzweigungen und Zusammenführungen, um eine Masterkopie zu kontrollieren und Konflikte zu verwalten.

Sie können einen neuen Entwurf erstellen, um Ihre Dokumentation mit individuellen Änderungen zu ergänzen. Innerhalb des Entwurfs können Sie Änderungen am Inhalt vornehmen sowie neue Seiten oder Seitengruppen hinzufügen. Nachdem Sie Ihre Änderungen vorgenommen haben, können Sie sie entweder zusammenführen oder zur Überprüfung einreichen.

Wenn Sie interne Dokumentation für Ihren Java-Code erstellen, möchten Sie vielleicht Javadoc erkunden. Mit Javadoc können Sie Ihren Java-Code automatisch dokumentieren.