menu

GitBook

GitBook est un outil online qui héberge des sites de documentation prenant en charge Markdown.

Aperçu

Puisqu'il s'agit d'un outil online, GitBook a un éditeur Markdown qui s'exécute directement dans votre navigateur, donc l'outil offre beaucoup de fonctionnalités pour vous permettre de créer votre documentation.

Si vous avez besoin de plus de contrôle sur votre contenu, GitBook prend également en charge l'intégration avec les référentiels GitHub.

Avec GitBook, vous pouvez créer votre site Web, puis le publier à l'aide d'un domaine personnalisé.

Mais il convient de mentionner que GitBook a commencé comme un projet open source et n'avait qu'une petite offre commerciale pour lever des fonds pour l'entreprise.

Aujourd'hui, l'outil est fermé et propriétaire, alors gardez cela à l'esprit si vous avez l'intention d'adhérer à l'utilisation de GitBook.

Le projet open source existe toujours et peut être utilisé par n'importe qui, mais GitBook ne prend plus en charge ce projet, donc seuls les éléments Markdown compatibles avec l'outil propriétaire seront listés.

Même étant une application fermée, GitBook présente toujours des avantages par rapport aux autres outils de ce type.

Par exemple, la construction et l'hébergement du site Web relèvent de la responsabilité du programme lui-même.

GitBook fournit un éditeur Markdown très intuitif, avec des contrôles WYSIWYG faciles à utiliser.

Ainsi, même les utilisateurs novices sont à l'aise pour éditer des documents Markdown.

Une autre caractéristique intéressante de l'outil est le masquage des marques de Markdown lorsque vous tapez.

L'éditeur peut sembler étrange au début, mais avec le temps, vous comprenez bien.

GitBook est également compatible avec le copier-coller, prenez votre contenu Markdown et collez-le directement dans l'interface de l'outil.

Le site officiel de GitBook se trouve à https://www.gitbook.com/.

Prise en charge de Markdown sur GitBook

Le Tableau 1.1 présente les éléments Markdown compatibles avec GitBook.

Élément Soutien Informations
Titres Ouais
Les paragraphes Ouais
Sauts de ligne Ouais
Gras Ouais
Italique Ouais
Blockquote Ouais
Listes ordonnées Ouais
Listes non ordonnées Ouais
Code Ouais
Lignes horizontales Non
Links Ouais
Images Ouais
les tables Ouais
Blocs de code clôturés Ouais Vous pouvez également mettre en évidence la syntaxe du langage de programmation du bloc.
Notes de bas de page Non
Identifiant du titre Ouais
Listes de définitions Non
Barré Ouais
Listes de tâches Ouais
Emoji (copier et coller) Inconnu
Emoji (codes d'accès) Inconnu
URL automatique Link Ouais
Désactiver URL automatique link Non
HTML Ouais

Voir aussi

Documentation Markdown sur GitBook