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

Écrivez et laissez le monde réviser votre travail avec Prose.io pour GitHub / l'Internet

Traditionnellement, l'écriture est une affaire solitaire. C'est juste vous et l'écran, ou un morceau de papier. Homme contre texte dans une bataille de volontés, d'esprits et d'émotions, jusqu'à ce que vous ayez fini, tout à coup. Il est maintenant temps de montrer au monde, de publier votre texte 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 c'était tout à l'air libre, tout au long? Et si le monde pouvait voir vos révisions et suivre en faisant des suggestions? À première vue, cela peut sembler une idée horrible - mais pour certains types de textes (et pour certains écrivains), une telle collaboration ouverte peut être une aubaine. Prose est une plate-forme de publication en ligne simple qui s'interface avec GitHub pour vous permettre de modifier du texte en ligne et de conserver des révisions à l'aide de Git Qu'est-ce que Git et pourquoi utiliser le contrôle de version si vous êtes développeur? Développeur En tant que développeur Web, nous avons souvent tendance à travailler sur des sites de développement locaux, puis à tout télécharger lorsque nous avons terminé. C'est bien quand c'est juste toi et les changements sont petits,… Read More .

Commencer

Pour travailler avec Prose, vous devez d'abord avoir un compte GitHub. En supposant que vous soyez connecté à Git, cliquez simplement sur le bouton Autoriser de Prose:

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

Ensuite, vous vous retrouverez dans Prose, en consultant une liste de tous vos référentiels Git:

Si vous êtes comme moi, aucun de vos référentiels existants ne convient parfaitement à un tas de textes. Bien entendu, cela peut ne pas être vrai pour vous: par exemple, si vous utilisez le framework de publication Jekyll, vous avez peut-être déjà un référentiel en attente de texte. En fait, une grande partie de Prose semble avoir été conçue pour les utilisateurs de Jekyll: Prose vous permet même de publier sur Jekyll. Cela dit, vous ne le faites pas avoir besoin Jekyll à utiliser Prose, et je l'ai regardé sans le relier à rien d'autre.

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

Créer un nouveau référentiel GitHub

Pour créer un nouveau référentiel 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 “des documents,” c'est ce que j'ai fait.

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

Editer un document

En cliquant dans mon nouveau dépôt de documents, je suis accueilli par le fichier README.md par défaut de GitHub. MD, dans ce cas, représente Markdown - le même format simple utilisé par Dillinger.io, TextDown, WriteMonkey et d’innombrables autres éditeurs. Si vous composez du texte pour une utilisation en ligne depuis un certain temps, il est probable que vous ayez rencontré Markdown plusieurs fois..

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

Il est parfaitement dépourvu de publicité et son jeu de couleurs discret est agréable à regarder. Il présente é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 au format HTML nécessite un clic rapide dans la barre d'outils:

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

L'éditeur a du 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, ce qui rend votre texte encore plus sujet aux fautes de frappe..

Publication (ou sauvegarde)

Sauf si vous utilisez Jekyll, la publication et l’enregistrement sont quasiment identiques: dès que vous enregistrez, votre texte est envoyé dans un référentiel GitHub. Sauf si vous êtes un utilisateur payant de GitHub et que vous avez opté pour un référentiel privé, cela signifie que tout le monde peut maintenant voir votre texte. Le premier commit ressemblait à ceci:

Et après quelques autres gribouillis rapides, l'historique de validation de GitHub pour le référentiel ressemblait à ceci:

Très transparent, mais également sécurisé: les révisions rendent presque impossible la perte de votre travail. Vous pouvez enregistrer, puis supprimer une grande partie de votre document, mais vous pourrez toujours 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 passez à un autre.

C'est loin de tout ce que Prose peut faire: par exemple, vous pouvez utiliser Prose pour modifier le document d'une autre personne et envoyer une demande d'extraction pour qu'elle accepte vos révisions, comme le font les codeurs. Vous pouvez faire beaucoup d'autres choses avec Prose, mais son principe fondamental reste le même: Git pour l'écriture.

Dernières pensées

Pour moi, Prose se sent plus comme une invitation que comme un outil. Une invitation à réfléchir, composer, rédiger, à l'air libre. Surpasser “peur de la publication” en publiant constamment comme vous écrivez, de sorte qu'il n'y a pas “moment de vérité” - vos pensées ont toujours été dans le monde, fautes de frappe, incohérences, etc. 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 organise simplement les choses proprement 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 que je serais curieux d'entendre, si vous me le disiez dans les commentaires.

En savoir plus sur: les outils de collaboration, l'éditeur de texte, le développement Web, les outils pour les webmasters.