gitbook
1.0.0
DOCS - Community - Entwickler Dokumente - Changelog - Fehlerberichte
Willkommen im Gitbook, der Plattform für das Verwalten von technischem Wissen für Teams.
Dieses Repository enthält den Open -Source -Code, mit dem die veröffentlichten Inhalte von Gitbook rendern.
Erste Schritte
Beitragen
Arten von Beiträgen
Lizenzierung
Anerkennung
Legacy Gitbook
Um eine lokale Version dieses Projekts auszuführen, befolgen Sie bitte diese einfachen Schritte.
Node.js (Version:> = 18.x)
Brötchen
Klonen Sie das Repo in ein öffentliches Github -Repository. Wenn Sie vorhaben, den Code zu verteilen, halten Sie den Quellcode öffentlich, um GNU GPLV3 einzuhalten. Um in einem privaten Repository zu klonen, erwerben Sie eine kommerzielle Lizenz.
git clone https://github.com/gitbookIO/gitbook.git
Stellen Sie sicher, dass Sie die node des Projekts verwenden. Wenn Sie nvm use ausführen, wird Ihre lokale Version auf die richtige geändert.
Installieren Sie die Abhängigkeiten des Projekts über Bun.
bun install
Starten Sie Ihren lokalen Entwicklungsserver.
bun dev
Öffnen Sie einen veröffentlichten Gitbook -Speicherplatz in Ihrem Webbrowser und belegen Sie ihn mit http://localhost:3000/ .
Beispiele:
http: // localhost: 3000/docs.gitbook.com
http: // localhost: 3000/open-source.gitbook.io/Midjourney
Auf jede veröffentlichte Gitbook -Website kann über Ihre lokale Entwicklungsinstanz zugegriffen werden. Alle Aktualisierungen, die Sie an der Codebasis erstellen, werden in Ihrem Browser widerspiegelt.
bun format : formatieren Sie den Code
bun lint : FININT DER CODE
Alle Pull-Requests werden sowohl gegen Visual- als auch gegen Performances-Tests getestet, um Regressionen zu verhindern.
Die Rendering -Engine von Gitbook ist vollständig Open Source und basiert auf dem nächsten.js. Gehen Sie zu unserem Beitrag zu unserem Beitrag, um mehr über den Workflow zum Hinzufügen Ihrer ersten Pull -Anfrage zu erfahren.
Wir ermutigen Sie, zum Gitbook beizutragen, um das beste Instrument zur Dokumentation technischer Kenntnisse aufzubauen. Wenn Sie nach schnellen Möglichkeiten suchen, um einen Beitrag zu leisten, lesen Sie weiter, um mehr über beliebte Beiträge zu erfahren.
Die Gitbook -Benutzeroberfläche wird unter Verwendung einer Reihe von Übersetzungsdateien in packages/gitbook/src/intl/translations gerendert. Wir begrüßen alle zusätzlichen Übersetzungen für die Benutzeroberfläche.
Begegnen Sie einen Fehler oder finden Sie ein Problem, das Sie beheben möchten? Wenn wir uns helfen, Probleme im Zusammenhang mit Gitbook zu beheben, verbessert es die Erfahrung für alle. Besuchen Sie den Abschnitt "Ausgaben" dieses Repositorys, um mehr über die Arten von Fehler zu erfahren, mit denen Sie bereits helfen können.
Warnung
Obwohl es möglich ist, dieses Projekt selbst zu veranstalten, empfehlen wir dies nicht, es sei denn, Sie sind sicher, dass diese Option zu Ihrem Bedarf passt.
Möchten Sie eine bestimmte Funktion in Gitbook hinzufügen? Besuchen Sie unseren Beitrag zu unserem Beitrag, um loszulegen.
Das Selbstversand dieses Projekts ist die Verantwortung für die Aufrechterhaltung und Verschmelzung zukünftiger Updates für Sie . Wir können keine Unterstützung, Wartung oder Aktualisierungen für gabelhafte und selbst gehostete Fälle dieses Projekts garantieren.
Wir möchten es unserer Community so einfach wie möglich machen, zusammenzuarbeiten und die Zukunft von Gitbook zu überschreiten, weshalb wir Sie dazu ermutigen, direkt zu unserem Produkt beizutragen, anstatt Ihre eigene Version zu erstellen.
Mit diesem Projekt können Sie den Rendering-Teil Ihres in Gitbook veröffentlichten Inhalts selbst veranstalten. Selbsthosting hat Vor- und Nachteile.
Auf der Pro -Seite können Sie das Erscheinungsbild Ihrer Inhalte anpassen und Ihre Dokumentation besser in Ihre Anwendung einbinden.
Auf der Betrüger werden Sie für die Zuverlässigkeit Ihrer veröffentlichten Website verantwortlich und halten den Renderer über die Änderungen an der Gitbook-Plattform auf dem neuesten Stand.
Unter der GNU GPLV3 -Lizenz verteilt.
Wenn Sie vorhaben, den Code zu verteilen, müssen Sie den Quellcode öffentlich machen, um die GNU GPLV3 einzuhalten. Um in einem privaten Repository zu klonen, erwerben Sie eine kommerzielle Lizenz.
Weitere Informationen finden Sie LICENSE .
[! [Gitbook] (https://img.shields.io/static/v1?message=documented%20on%20Gitbook&logo=gitbook&logocolor=ffffffffffffffffs&label=%20&labelcolor=5c5c Dicol=3f89a1) (https
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=documented%20on%20gitbook boogo=gitbook&logocolor=ffffffffel=ove book120&label "
/> </a>Gitbook wäre ohne diese Projekte nicht möglich:
Weiter.js
Brötchen
Rückenwind -CSS
Framer -Bewegung
Unsere frühere Version von Gitbook und CLI -Tool ist jetzt veraltet. Sie können immer noch das alte Repository anzeigen und es begeht in dieser Filiale.
