Visual Studio Code (alpha)

L’intégration GitBook pour Visual Studio Code vous permet de capturer et de retrouver des informations dans la base de connaissances de votre équipe.

Cette fonctionnalité n'est plus maintenue dans GitBook et est sujette à modification.

L'intégration GitBook pour Visual Studio Code vous permet de rechercher et de poser des questions sur votre documentation et vos connaissances, directement dans votre éditeur de code. Avec un panneau latéral dédié et une liste de différentes commandes, vous pouvez facilement exploiter les connaissances de toute votre équipe directement dans l'outil que vous utilisez chaque jour.

Installation et configuration

Vous pouvez installer l'intégration Visual Studio Code depuis l'écran d'accueil de l'application GitBook, ou depuis le marketplace des extensions Visual Studio Code.

Après avoir installé l'intégration dans Visual Studio Code, vous devrez vous connecter à votre compte GitBook afin de terminer la configuration.

L'extension GitBook pour Visual Studio Code n'est disponible que pour Macs avec puce Apple et les PC Windows pour le moment.

1. Connectez-vous à GitBook avec votre jeton développeur

Pour que Visual Studio Code puisse accéder à GitBook, vous devez autoriser votre IDE en ajoutant un jeton développeur. Vous pouvez générer un nouveau jeton développeur GitBook dans vos paramètres développeur.

Une fois que vous avez votre jeton, vous pouvez l'ajouter à Visual Studio Code via la palette de commandes (⌘+⇧+P), sous GitBook : Se connecter à GitBook.

2. Sélectionnez votre organisation GitBook

Après avoir enregistré votre jeton d'accès personnel, vous devrez choisir l'organisation à laquelle vous souhaitez ajouter vos extraits de code .

Dans la palette de commandes, vous pouvez choisir une organisation sous l'option GitBook : Changer d'organisation. Si vous ne faites partie que d'une seule organisation, elle sera déjà sélectionnée pour vous.

Posez des questions sur vos documents GitBook

En utilisant l'extension GitBook pour VS Code, vous pouvez poser des questions contextuelles dans le panneau latéral pour accéder aux connaissances de votre équipe. Cette section contient également une liste des extraits récents ajoutés par les membres de votre équipe, afin que vous puissiez rapidement voir ce que les autres enregistrent dans la base de connaissances de votre équipe depuis VS Code.

Pour obtenir des informations, ouvrez simplement le panneau GitBook et tapez votre requête dans la barre de recherche. Vous obtiendrez un résultat résumé basé sur les informations de votre organisation GitBook.

Cette fonctionnalité nécessite que GitBook AI Search (bêta) soit activé pour votre organisation.