Une plateforme de stockage et d'organisation des informations et de la documentation. Les détails de BookStack peuvent être trouvés sur le site officiel à l'adresse https://www.bookstackapp.com/.
Instructions d'installation
Documentation
Instance de démonstration
Connexion administrateur
Captures d'écran
Blog BookStack
Liste des problèmes
Discussion Discorde
Options d'assistance
BookStack est une plate-forme de documentation avisée qui offre une expérience prête à l'emploi agréable et simple. Les nouveaux utilisateurs d'une instance devraient trouver l'expérience intuitive et seules des compétences de base en traitement de texte devraient être requises pour s'impliquer dans la création de contenu sur BookStack. La plate-forme doit fournir des fonctionnalités avancées à ceux qui le souhaitent, mais elles ne doivent pas interférer avec l'expérience utilisateur simple de base.
BookStack n'est pas conçu comme une plate-forme extensible destinée à être utilisée à des fins différentes de celles décrites ci-dessus.
En ce qui concerne la philosophie de développement, BookStack a une approche détendue, ouverte et positive. En fin de compte, il s’agit d’un logiciel libre développé et maintenu par des personnes qui font don de leur temps libre.
Vous pouvez en savoir plus sur le projet et ses origines dans notre FAQ ici.
Vous trouverez ci-dessous nos sponsors de projets bronze, argent et or. Un grand merci à ces entreprises pour avoir soutenu le projet. Remarque : Les services répertoriés ne sont ni testés, ni approuvés, ni pris en charge de quelque manière que ce soit par le projet officiel BookStack.
Détails du don du projet - Page des sponsors GitHub - Page Ko-fi
Veuillez consulter nos documents de développement pour plus de détails concernant le travail sur le code source de BookStack.
Si vous cherchez simplement à personnaliser ou à étendre votre propre instance BookStack, jetez un œil à notre page de documentation Hacking BookStack pour plus de détails sur les différentes options permettant d'y parvenir sans modifier le code source de BookStack.
Des détails sur le système de gestion des versions de BookStack et le processus de publication général peuvent être trouvés ici.
Les traductions de texte dans BookStack sont gérées via le projet BookStack sur Crowdin. Certaines chaînes ont des variables préfixées par deux points telles que :userName
. Laissez ces valeurs telles quelles car elles seront remplacées au moment de l’exécution.
Veuillez utiliser Crowdin pour contribuer aux traductions au lieu d'ouvrir une pull request. Les traductions dans la base de code de travail peuvent être obsolètes et la fusion via le code peut provoquer des conflits et des problèmes de synchronisation. Si, pour une raison quelconque, vous ne pouvez pas utiliser Crowdin, n'hésitez pas à ouvrir un ticket pour discuter des options alternatives.
Si vous souhaitez qu'une nouvelle langue soit ajoutée à Crowdin, pour que vous puissiez fournir des traductions, veuillez ouvrir un nouveau numéro ici.
Veuillez noter que les traductions dans BookStack sont fournies à la « Mémoire de traduction globale Crowdin » qui aide BookStack et d'autres projets à trouver des traductions. Si vous n'êtes pas satisfait de contribuer à cela, il n'est pas conseillé de fournir des traductions à BookStack, même manuellement via GitHub.
N'hésitez pas à créer des problèmes pour demander de nouvelles fonctionnalités ou pour signaler des bugs et des problèmes. Veuillez simplement suivre le modèle donné lors de la création du problème.
Les demandes d'extraction sont les bienvenues mais, à moins qu'il ne s'agisse d'un petit ajustement, il peut être préférable d'ouvrir la demande d'extraction plus tôt ou de créer un problème pour la modification envisagée afin de discuter de la manière dont elle s'intégrera dans le projet et de planifier la fusion. Ce n’est pas parce qu’une demande de fonctionnalité existe ou est étiquetée que cette fonctionnalité sera acceptée dans le projet principal.
Les demandes d'extraction doivent être créées à partir de la branche development
car elles seront fusionnées dans development
une fois terminées. Veuillez ne pas créer ni demander de fusion dans la branche release
, car cela concerne uniquement la publication de versions. Si vous souhaitez modifier le contenu CSS ou JavaScript, veuillez modifier les fichiers sources trouvés dans resources/
. Tous les fichiers CSS ou JS public
sont créés à partir de ces fichiers sources et ne doivent donc pas être modifiés directement.
Le code de conduite du projet peut être consulté ici.
Les informations de sécurité pour l'administration d'une instance BookStack peuvent être trouvées sur le site de documentation ici.
Si vous souhaitez être informé de nouveaux problèmes de sécurité potentiels, vous pouvez vous inscrire à la liste de diffusion de sécurité BookStack.
Si vous souhaitez signaler un problème de sécurité, les détails à ce sujet peuvent être trouvés ici.
Nous souhaitons que BookStack reste accessible au plus grand nombre. Nous visons au moins les normes WCAG 2.1 niveau A lorsque cela est possible, même si nous ne testons pas strictement cela à chaque version. Si vous rencontrez des problèmes d'accessibilité, n'hésitez pas à ouvrir un problème.
Le site Web qui contient la documentation et le blog du projet se trouve dans le dépôt BookStackApp/website.
La source BookStack est fournie sous la licence MIT.
Les bibliothèques utilisées et incluses avec BookStack sont fournies sous leurs propres licences et droits d'auteur. Les licences pour bon nombre de nos dépendances principales peuvent être trouvées dans la liste d'attribution ci-dessous, mais il ne s'agit pas d'une liste exhaustive de tous les projets utilisés dans BookStack.
Les personnes formidables qui ont travaillé pour créer et améliorer BookStack peuvent être vues ici. Les personnes formidables qui ont fourni des traductions, soit via GitHub, soit via Crowdin, peuvent être vues ici.
Vous trouverez ci-dessous les grands projets open source utilisés pour aider à créer BookStack. Remarque : Il ne s'agit pas d'une liste exhaustive de toutes les bibliothèques et projets qui seraient utilisés dans une instance BookStack active.
Laravel- MIT
TinyMCE - MIT
Lexical - MIT
CodeMirror - MIT
Triable - MIT
Icônes matérielles Google - Apache-2.0
listes de tâches markdown-it et markdown-it - MIT et ISC
Dompdf- LGPL v2.1
KnpLabs/snappy - MIT
WKHTMLtoPDF - LGPL v3.0
diagrammes.net - Termes de la version intégrée / Projet source - Apache-2.0
Boîte à outils SAML PHP de OneLogin - MIT
Ligue/CommonMark - Clause BSD-3
Ligue/Flysystem - MIT
Ligue/html-to-markdown - MIT
League/oauth2-client - MIT
pragmarx/google2fa - MIT
Bacon/BaconQrCode - Clause BSD-2
phpseclib- MIT
Mécanique - MIT
PHPStan & Larastan - MIT et MIT
PHP_CodeSniffer - Clause BSD à 3 clauses
JakeArchibald/IDB-Keyval - Apache-2.0
Pour une ventilation détaillée des projets JavaScript et PHP importés et utilisés via les gestionnaires de packages NPM et composer, ainsi que leurs licences, veuillez consulter les fichiers dev/licensing/js-library-licenses.txt et dev/licensing/php-library-licenses. fichiers txt.