BookStack
v24.10.3
Eine Plattform zum Speichern und Organisieren von Informationen und Dokumentation. Details zu BookStack finden Sie auf der offiziellen Website unter https://www.bookstackapp.com/.
Installationsanweisungen
Dokumentation
Demo-Instanz
Admin-Login
Screenshots
BookStack-Blog
Problemliste
Discord-Chat
Support-Optionen
BookStack ist eine eigenwillige Dokumentationsplattform, die ein angenehmes und einfaches Out-of-the-Box-Erlebnis bietet. Neue Benutzer einer Instanz sollten die Erfahrung intuitiv finden und es sollten nur grundlegende Textverarbeitungsfähigkeiten erforderlich sein, um an der Erstellung von Inhalten auf BookStack teilzunehmen. Die Plattform sollte denjenigen, die dies wünschen, erweiterte Leistungsfunktionen bieten, die jedoch das grundlegende, einfache Benutzererlebnis nicht beeinträchtigen sollten.
BookStack ist nicht als erweiterbare Plattform für Zwecke konzipiert, die von der obigen Aussage abweichen.
In Bezug auf die Entwicklungsphilosophie verfolgt BookStack einen entspannten, offenen und positiven Ansatz. Letztlich handelt es sich dabei um kostenlose Software, die von Menschen entwickelt und gepflegt wird, die ihre eigene Freizeit spenden.
Mehr über das Projekt und seine Ursprünge können Sie hier in unseren FAQ lesen.
Unten sind unsere Bronze-, Silber- und Gold-Projektsponsoren aufgeführt. Vielen Dank an diese Unternehmen für die Unterstützung des Projekts. Hinweis: Die aufgeführten Dienste werden vom offiziellen BookStack-Projekt in keiner Weise getestet, überprüft oder unterstützt.
Details zur Projektspende – GitHub-Sponsorenseite – Ko-Fi-Seite
Ausführliche Informationen zur Arbeit am BookStack-Quellcode finden Sie in unseren Entwicklungsdokumenten.
Wenn Sie nur Ihre eigene BookStack-Instanz anpassen oder erweitern möchten, werfen Sie einen Blick auf unsere Dokumentationsseite zum Hacken von BookStack. Dort finden Sie Einzelheiten zu verschiedenen Optionen, um dies zu erreichen, ohne den BookStack-Quellcode zu ändern.
Details zum Versionierungsschema von BookStack und zum allgemeinen Veröffentlichungsprozess finden Sie hier.
Übersetzungen für Text in BookStack werden über das BookStack-Projekt auf Crowdin verwaltet. Einige Zeichenfolgen haben Variablen mit Doppelpunkt als Präfix, z. B. :userName . Lassen Sie diese Werte unverändert, da sie zur Laufzeit ersetzt werden.
Bitte verwenden Sie Crowdin, um Übersetzungen beizutragen, anstatt eine Pull-Anfrage zu öffnen. Die Übersetzungen innerhalb der Arbeitscodebasis können veraltet sein und das Zusammenführen über Code kann zu Konflikten und Synchronisierungsproblemen führen. Wenn Sie Crowdin aus irgendeinem Grund nicht nutzen können, können Sie gerne ein Problem eröffnen, um alternative Optionen zu besprechen.
Wenn Sie Crowdin eine neue Sprache hinzufügen möchten, für die Sie Übersetzungen bereitstellen können, öffnen Sie bitte hier eine neue Ausgabe.
Bitte beachten Sie, dass Übersetzungen in BookStack dem „Crowdin Global Translation Memory“ zur Verfügung gestellt werden, das BookStack und anderen Projekten bei der Suche nach Übersetzungen hilft. Wenn Sie nicht damit zufrieden sind, dazu beizutragen, ist es nicht ratsam, BookStack Übersetzungen bereitzustellen, auch nicht manuell über GitHub.
Sie können gerne Issues erstellen, um neue Funktionen anzufordern oder Fehler und Probleme zu melden. Bitte folgen Sie einfach der Vorlage, die Sie beim Erstellen der Ausgabe erhalten haben.
Pull-Requests sind willkommen. Sofern es sich jedoch nicht um eine kleine Änderung handelt, ist es möglicherweise am besten, den Pull-Request frühzeitig zu öffnen oder ein Issue für die beabsichtigte Änderung zu erstellen, um zu besprechen, wie sie in das Projekt passt, und die Zusammenführung zu planen. Nur weil eine Funktionsanfrage vorliegt oder mit einem Tag versehen ist, heißt das nicht, dass diese Funktion in das Kernprojekt aufgenommen wird.
Pull-Requests sollten aus dem development erstellt werden, da sie nach Abschluss wieder in development eingebunden werden. Bitte erstellen Sie nicht aus dem release -Zweig und fordern Sie auch keine Zusammenführung in diesem an, da dies nur für die Veröffentlichung von Releases gilt. Wenn Sie CSS- oder JavaScript-Inhalte ändern möchten, bearbeiten Sie bitte die Quelldateien in resources/ . Alle public CSS- oder JS-Dateien werden aus diesen Quelldateien erstellt und sollten daher nicht direkt bearbeitet werden.
Den Verhaltenskodex des Projekts finden Sie hier.
Sicherheitsinformationen zur Verwaltung einer BookStack-Instanz finden Sie auf der Dokumentationsseite hier.
Wenn Sie über neue potenzielle Sicherheitsbedenken informiert werden möchten, können Sie sich bei der BookStack-Sicherheitsmailingliste anmelden.
Wenn Sie ein Sicherheitsbedenken melden möchten, finden Sie hier Einzelheiten dazu.
Wir möchten, dass BookStack für möglichst viele Menschen zugänglich bleibt. Wir streben nach Möglichkeit mindestens WCAG 2.1 Level A-Standards an, obwohl wir dies nicht bei jeder Veröffentlichung streng testen. Wenn Sie auf Probleme mit der Barrierefreiheit stoßen, können Sie gerne ein Problem eröffnen.
Die Website, die die Projektdokumente und den Blog enthält, finden Sie im BookStackApp/website-Repository.
Die BookStack-Quelle wird unter der MIT-Lizenz bereitgestellt.
Die von BookStack verwendeten und in BookStack enthaltenen Bibliotheken unterliegen ihren eigenen Lizenzen und Urheberrechten. Die Lizenzen für viele unserer Kernabhängigkeiten finden Sie in der untenstehenden Namensnennungsliste. Dies ist jedoch keine vollständige Liste aller in BookStack verwendeten Projekte.
Die großartigen Menschen, die an der Entwicklung und Verbesserung von BookStack gearbeitet haben, können Sie hier sehen. Die wunderbaren Menschen, die Übersetzungen bereitgestellt haben, entweder über GitHub oder über Crowdin, können hier gesehen werden.
Nachfolgend finden Sie die großartigen Open-Source-Projekte, die zur Erstellung von BookStack verwendet wurden. Hinweis: Dies ist keine vollständige Liste aller Bibliotheken und Projekte, die in einer aktiven BookStack-Instanz verwendet würden.
Laravel – MIT
TinyMCE - MIT
Lexikalisch - MIT
CodeMirror – MIT
Sortierbar - MIT
Google Material Icons – Apache-2.0
markdown-it und markdown-it-task-lists – MIT und ISC
Dompdf – LGPL v2.1
KnpLabs/snappy – MIT
WKHTMLtoPDF – LGPL v3.0
Diagramme.net – Bedingungen der eingebetteten Version / Quellprojekt – Apache-2.0
Das SAML-PHP-Toolkit von OneLogin – MIT
League/CommonMark – BSD-3-Klausel
Liga/Flugsystem – MIT
League/html-to-markdown – MIT
League/oauth2-client – MIT
pragmarx/google2fa – MIT
Bacon/BaconQrCode – BSD-2-Klausel
phpseclib – MIT
Uhrwerk – MIT
PHPStan & Larastan – MIT und MIT
PHP_CodeSniffer – BSD 3-Klausel
JakeArchibald/IDB-Keyval – Apache-2.0
Eine detaillierte Aufschlüsselung der über NPM- und Composer-Paketmanager importierten und verwendeten JavaScript- und PHP-Projekte sowie deren Lizenzen finden Sie in dev/licensing/js-library-licenses.txt und dev/licensing/php-library-licenses. txt-Dateien.
