gitbook
1.0.0
Docs - Communauté - Développeur Docs - Changelog - Rapports de bogues
Bienvenue à GitBook, la plate-forme de gestion des connaissances techniques pour les équipes.
Ce référentiel contient le code open source utilisé pour rendre le contenu publié de GitBook.
Commencer
Contributif
Types de contributions
Licence
Remerciements
Héritage gitbook
Pour exécuter une version locale de ce projet, veuillez suivre ces étapes simples.
Node.js (version:> = 18.x)
Chignon
Clone le repo dans un référentiel GitHub public . Si vous prévoyez de distribuer le code, gardez le code source public pour vous conformer à GNU GPLV3. Pour cloner dans un référentiel privé, acquérir une licence commerciale.
git clone https://github.com/gitbookIO/gitbook.git
Assurez-vous que vous utilisez la version du node du projet. L'exécution nvm use changera votre version locale en bonne.
Installez les dépendances du projet via BUN.
bun install
Démarrez votre serveur de développement local.
bun dev
Ouvrez un espace GitBook publié dans votre navigateur Web, en le préfixant avec http://localhost:3000/ .
Exemples:
http: // localhost: 3000 / docs.gitbook.com
http: // localhost: 3000 / open-Source.gitbook.io / midjourney
Tout site GitBook publié est accessible via votre instance de développement locale, et toutes les mises à jour que vous effectuez à la base de code seront reflétées dans votre navigateur.
bun format : Formater le code
bun lint : Lint le code
Tous les requêtes de traction seront testées contre les tests visuels et des performances pour empêcher les régressions.
Le moteur de rendu de GitBook est entièrement open source et construit au-dessus de Next.js. Rendez-vous à notre guide de contribution pour en savoir plus sur le flux de travail sur l'ajout de votre première demande de traction.
Nous vous encourageons à contribuer à Gitbook pour nous aider à créer le meilleur outil pour documenter les connaissances techniques. Si vous cherchez des moyens rapides de contribuer, continuez à lire pour en savoir plus sur les contributions populaires.
L'interface utilisateur GitBook est rendue à l'aide d'un ensemble de fichiers de traduction trouvés dans packages/gitbook/src/intl/translations . Nous accueillons toutes les traductions supplémentaires pour l'interface utilisateur.
Rencontrer un bogue ou trouver un problème que vous souhaitez résoudre? Nous aider à résoudre les problèmes liés à GitBook améliore considérablement l'expérience pour tout le monde. Dirigez-vous vers la section des problèmes de ce référentiel pour en savoir plus sur les types de bogues avec lesquels vous pouvez déjà aider.
Avertissement
Bien qu'il soit possible d'auto-héberger ce projet, nous ne recommandons cela que si vous êtes certain que cette option correspond à votre besoin.
Vous cherchez à ajouter une fonctionnalité spécifique dans GitBook? Rendez-vous à notre guide contributeur pour commencer.
L'auto-hébergement de ce projet met la responsabilité de maintenir et de fusionner les futures mises à jour sur vous . Nous ne pouvons garantir le support, la maintenance ou les mises à jour des instances fourchues et auto-hébergées de ce projet.
Nous voulons faciliter la collaboration et pousser l'avenir de Gitbook, c'est pourquoi nous vous encourageons à contribuer directement à notre produit au lieu de créer votre propre version.
Ce projet vous permet d'auto-héberger la partie de rendu de votre contenu publié GitBook. L'auto-hébergement a des avantages et des inconvénients.
Du côté professionnel, vous pouvez personnaliser l'apparence de votre contenu et mieux intégrer votre documentation dans votre application.
À côté, vous devenez responsable de la fiabilité de votre site publié et en gardant le rendu à jour avec les modifications apportées à la plate-forme GitBook.
Distribué sous la licence GNU GPLV3.
Si vous prévoyez de distribuer le code, vous devez rendre le code source public pour vous conformer au GNU GPLV3. Pour cloner dans un référentiel privé, acquérir une licence commerciale.
Voir LICENSE pour plus d'informations.
[! [Gitbook] (https://img.shields.io/static/v1?Message=Documented%20on%20GitBook&logo=gitbook&logocolor=ffffff&label=%20&labelcolor=5c5c5c&color=3f89a1)] (https://gitbook.com/)
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?Message=Documented%20on%20GitBook&Logo=GitBook&Logocolor=ffffff&color=3f.%20&labelcolor=5c5c5cfff&color= "
/> </a>Gitbook ne serait pas possible sans ces projets:
Next.js
Chignon
CSS du vent arrière
Mouvement de rédaction
Notre version précédente de GitBook et son outil CLI sont désormais obsolètes. Vous pouvez toujours afficher l'ancien référentiel et il s'engage sur cette branche.
