Écrivez, et laissez le monde réviser votre travail avec Prose.io pour GitHub

Publicité

Traditionnellement, l'écriture est une affaire solitaire. C'est juste toi et l'écran, ou un morceau de papier. Homme contre texte dans une bataille de volontés, d'intelligence et d'émotion, jusqu'à ce que soudainement - vous avez terminé. Maintenant, il est temps de montrer au monde, de mettre votre texte là-bas et de regarder ce qui se passe. Mais en ces temps numériques, ce n'est pas la seule façon d'écrire.

Et si tout était ouvert, tout le long? Et si le monde pouvait voir vos révisions et suivre, faire des suggestions? À première vue, cela peut sembler une idée horrible - mais pour certains types de textes (et pour certains auteurs), une telle collaboration ouverte peut être un avantage. Prose est une plate-forme de publication en ligne simple qui s'interface avec GitHub pour vous permettre de modifier le texte en ligne et conserver les révisions en utilisant Git Qu'est-ce que Git & Pourquoi vous devriez utiliser le contrôle de version Si vous êtes un développeur est un développeur En tant que développeurs web, nous travaillons souvent sur des sites de développement locaux, puis nous téléchargeons tout lorsque nous avons terminé. C'est bien quand c'est juste vous et les changements sont petits, ... Lire la suite.

Commencer

Pour travailler avec Prose, vous devez d'abord avoir un compte GitHub. En supposant que vous êtes connecté à Git, il vous suffit de cliquer sur le bouton Author de la liste:

Git demandera alors si vous êtes sûr de vouloir autoriser Prose. La prose nécessite pas mal d'autorisations, mais elles ont toutes un sens:

Ensuite, vous vous retrouverez dans Prose, en regardant une liste de tous vos dépôts Git:

Si vous êtes comme moi, aucun de vos dépôts existants ne convient à un tas de texte. Bien sûr, cela peut ne pas être vrai pour vous: par exemple, si vous utilisez le framework de publication Jekyll, il se peut que vous ayez déjà un référentiel qui n'attend que du texte. En fait, une grande partie de Prose semble être construite en pensant aux utilisateurs de Jekyll: Prose vous permet même de publier sur Jekyll. Cela dit, vous n'avez pas besoin de Jekyll pour utiliser Prose, et je l'ai regardé sans le relier à autre chose.

Alors, pour commencer, faisons une nouvelle maison pour notre texte.

Créer un nouveau référentiel GitHub

Pour créer un nouveau dépôt GitHub, vous devez revenir à GitHub lui-même - ce n'est pas quelque chose que vous pouvez faire sur Prose. Prose suggère de nommer votre nouveau référentiel "documents", c'est ce que j'ai fait.

Immédiatement après la création du référentiel, il est apparu dans Prose:

Modifier un document

En cliquant sur mon nouveau répertoire Documents, je suis accueilli par le fichier README.md par défaut de GitHub. MD, dans ce cas, signifie Markdown - le même format simple utilisé par Dillinger.io, TextDown, WriteMonkey, et d'innombrables autres éditeurs. Si vous avez composé du texte pour une utilisation en ligne pour une durée quelconque, vous avez probablement rencontré Markdown plus d'une fois.

En cliquant sur le document, une interface d'édition simple est apparue:

Il est parfaitement libre de toute publicité, et a une palette de couleurs douces qui est facile pour les yeux. Il a également la coloration syntaxique pour Markdown, et au lieu d'un volet de prévisualisation instantanée (comme celui utilisé dans Dillinger.io), la prévisualisation de votre texte rendu en HTML nécessite un clic rapide sur la barre d'outils:

Vous pouvez accéder à l'écran d'aperçu en utilisant Ctrl + Shift + flèche droite. Ctrl + Maj + flèche vers la gauche vous amène à une feuille de triche Markdown, au cas où vous souhaitez vous rafraîchir la mémoire.

L'éditeur a du bon goût, mais n'offre pas de fonctionnalité de comptage de mots en direct, ce que j'attendrais de tout outil destiné aux écrivains. Il désactive également le correcteur orthographique intégré de Chrome, rendant votre texte plus vulnérable aux fautes de frappe.

Publication (ou sauvegarde)

Sauf si vous utilisez Jekyll, la publication et l'enregistrement sont à peu près la même chose: dès que vous enregistrez, votre texte est validé dans un référentiel GitHub. Sauf si vous êtes un utilisateur GitHub payant et avez opté pour un dépôt privé, tout le monde peut désormais voir votre texte. Le premier commit ressemblait à ceci:

Et après quelques autres gribouillages rapides, l'historique des commit de GitHub pour le dépôt ressemblait à ceci:

Très transparent, mais aussi sécurisé: Les révisions rendent presque impossible la perte de votre travail. Vous pouvez enregistrer, puis supprimer un gros morceau de votre document, mais vous seriez toujours en mesure de le récupérer. C'est comme une fonction d'annulation illimitée qui continue de fonctionner même si vous éteignez votre ordinateur ou si vous en changez un autre.

C'est loin de tout ce que la Prose peut faire: Par exemple, vous pouvez utiliser Prose pour éditer le document d'une autre personne et soumettre une demande d'extraction pour qu'elle accepte vos révisions - tout comme le font les codeurs. Il y a beaucoup d'autres choses que vous pourriez faire avec Prose, mais son principe de base reste le même: Git pour l'écriture.

Dernières pensées

Pour moi, Prose ressemble plus à une invitation qu'à un outil. Une invitation à penser, composer, rédiger, sortir à l'air libre. Pour surmonter la «peur de la publication» en publiant constamment en écrivant, afin qu'il n'y ait pas un seul «moment de vérité» - vos pensées ont toujours été présentes dans le monde, les fautes de frappe, les incohérences et tout le reste. Il existe d'autres moyens de le faire, des wikis aux clients Git standard, mais Prose ne prétend pas être une idée exclusive - il ne fait qu'emballer les choses pour que le concept se démarque. Que ce soit ou non la bonne façon pour vous d'écrire est un choix personnel - un choix dont je serais curieux d'entendre parler, si vous me le dites dans les commentaires.