É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. L'homme contre le texte dans une bataille de volontés, d'esprit et d'émotion, jusqu'à ce que tout à coup - vous avez terminé. Il est maintenant temps de montrer au monde, de diffuser 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 dehors en plein air? 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 le texte en ligne et de conserver les révisions en utilisant Git Qu'est-ce que Git et pourquoi vous devriez utiliser le contrôle de version si vous êtes développeurEn tant que développeurs Web, la plupart du temps, nous avons 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 que 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, cliquez simplement sur le bouton Autoriser Prose:

Git vous demandera alors si vous êtes sûr de vouloir autoriser Prose. La prose nécessite plusieurs 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 à un tas de texte. Bien sûr, cela peut ne pas être vrai pour vous: par exemple, si vous utilisez le Jekyll cadre de publication, vous avez peut-être déjà un référentiel qui n'attend que du texte. En fait, une grande partie de Prose semble être conçue pour les utilisateurs de Jekyll: Prose vous permet même de publier sur Jekyll. Cela dit, vous n'avez pas avoir besoin Jekyll pour utiliser Prose, et je l'ai regardé sans le connecter à autre chose.

Alors, pour commencer, créons une nouvelle maison pour notre texte.

Création d'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 vos nouveaux «documents» de référentiel, alors c'est ce que j'ai fait.

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

Modification d'un document

En cliquant dans mon nouveau référentiel de 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 Dillinger: Modifier et afficher le démarque en temps réel Lire la suite , TextDown TextDown: intégrez un éditeur de démarques dans Google Chrome Lire la suite , WriteMonkey WriteMonkey - Un éditeur de texte simple pour les personnes facilement distraites Lire la suite 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 plus d'une fois.

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

Il est parfaitement exempt de toute publicité et a une palette de couleurs silencieuses qui est agréable pour les yeux. Il a également une coloration syntaxique pour Markdown, et au lieu d'un volet d'aperçu instantané (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 + 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 est de 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, ce qui rend votre texte beaucoup plus sujet 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 enregistré dans un référentiel GitHub. À moins que vous ne soyez un utilisateur GitHub payant et que vous ayez opté pour un référentiel privé, cela signifie que tout le monde peut désormais voir votre texte. Le premier commit ressemblait à ceci:

Et après quelques gribouillages plus rapides, l'historique des validations de GitHub pour le référentiel ressemblait à ceci:

Très transparent, mais aussi sécurisé: les révisions rendent presque impossible de perdre 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 soumettre une demande d'extraction pour qu'elle accepte vos révisions, tout comme 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, la prose ressemble plus à une invitation qu'à un outil. Une invitation à réfléchir, composer, rédiger, à l'air libre. Pour surmonter la «peur de la publication» en publiant constamment au fur et à mesure que vous écrivez, afin qu'il n'y ait pas un seul "Moment de vérité" - vos pensées ont toujours été présentes dans le monde, fautes de frappe, incohérences, et tout. Il y a d'autres façons de le faire, des wikis aux clients Git standard, mais Prose ne prétend pas être une idée exclusive - il conditionne simplement les choses de manière à ce que le concept se démarque. Que ce soit la bonne façon d'écrire ou non est un choix personnel - un choix dont je serais curieux d'entendre parler, si vous me le dites dans les commentaires.