- Coachman, mais loin d'être libéré?
- Oui, un couple de composition.
Est arrivé à la fin - j'écris dans Habr sur la façon d'écrire dans Habr. Bien qu'il y ait des raisons - je fais cela depuis cinq ans, j'ai vu et essayé un tas d'outils, alors maintenant je partage le meilleur avec vous.
Je vais vous expliquer comment passer d'un balisage HTML dans l'éditeur Habra à une mise en page significative, une conception de publication rapide et une collaboration productive. Ici - à propos de mon expérience dans Yandex.Money et comment j'ai organisé le travail sur les habratextes afin que ce ne soit pas atrocement douloureux.
Les styles sont notre tout
Je vais commencer par quelque chose qui n'est pas le plus évident pour un tel post.
Styles - une chose que j'insuffle activement à mes collègues et étudiants. Il ne s'agit pas d'infostil ou scientifique et artistique, mais de l'apparence de votre texte. Si vous apprenez un jour à créer des styles , il n'y aura pas de retour en arrière. (Les gars de LaTex ricanèrent sournoisement à cet endroit - vous êtes trop cool, laissez-nous les simples mortels s'amuser avec la conception.)
Menu que personne ne sait utiliser
L'essentiel est simple - vous faites un morceau de texte de la bonne façon, enregistrez le modèle, puis appliquez-le où vous en avez besoin. Ce modèle est appelé un style dans Word et Google Docs. Les étudiants qui composent le diplôme dans des styles sont 90% plus heureux que ceux qui ont changé manuellement la police, l'indentation et tout le reste pour chaque paragraphe et titre sur cent pages de texte.
Avec Habr, bien sûr, tout est plus simple - il suffit de comprendre la structure de votre article et d'organiser les en-têtes du niveau souhaité. Gérer cela est assez simple - h1, h2, h3 et h4 - comme en html.
Traiter avec marcdown
Si vous ne l'avez pas encore fait.
Markdown est une entité qui me fait peur depuis qu'elle est apparue dans l'éditeur habra. Il ressemblait à quelque chose d'hostile et contrairement aux balises HTML habituelles et complètement repoussé de lui-même. La pratique a montré qu'il vaut mieux choisir l'une des deux options.
Même si vous écrivez dans l'éditeur Habr intégré (bien que l'administration ne recommande pas de le faire), le démarquage vous fera économiser beaucoup de temps et d'efforts. Bien sûr, il vaut mieux choisir un autre outil. L'éditeur Habra convient pour un aperçu correct, et c'est tout.
La démarque est légèrement différente d'un cas à l'autre. Habr a une démarque à son goût - le lien est un guide compréhensible, à partir duquel il vaut vraiment la peine de commencer le chemin vers le monde du manque de souffrance dans la disposition des habraposts.
Où écrire?
Écrivez où cela vous convient. La seule chose à retenir: c'est pratique d'écrire! = C'est pratique de composer pour Habr. Si vim vous convient, allez-y, je vous parlerai de façons plus conservatrices d'écrire des textes et de leur application sur Habré.
Dans Yandex.Money, nous écrivons de différentes manières - différents auteurs ont différents éditeurs de texte familiers, et j'essaie de ne pas trop les forcer. Certains auteurs envoient des documents texte sur Yandex.Disk ou par courrier, d'autres écrivent immédiatement sur le marché ou dans des services de coédition.
Code Visual Studio (ou Sublime)
J'écris ce texte (et la plupart des autres) dans VS Code, en plein marché. La moitié gauche de l'écran est pour le texte, et la moitié droite est l'affichage du texte composé dans Markdown via le plug-in correspondant. Le plugin s'appelle Markdown MPE Preview - il prend en charge le téléchargement d'images à partir d'un ordinateur pour l'imaginer et l'insertion de liens au bon endroit dans le texte.
Post-post, méta-méta
Certains écrivains peuvent me blâmer - ils disent que Sublime Text 3 est meilleur. Je sais avec certitude qu'il y a aussi tout ce qu'il faut pour travailler avec le marqdown - utilisez-le si vous préférez. Eh bien, en général, il y a des dizaines, voire des centaines d'éditeurs, pour toutes les plateformes et pour tous les goûts. L'essentiel est de bien écrire :)
Microsoft Word
Si vous avez un ordinateur Windows, Word y est probablement installé. Et vos co-auteurs (si vous avez des co-auteurs), très probablement aussi. Il s'agit d'un outil normal et familier pour la plupart, bien que payé.
Le problème est que dans Word (si vous n'avez pas d'abonnement royal), vous ne pouvez pas modifier les documents ensemble, ce qui signifie que le travail sera réduit à Draft_Habr_Testing_development_final_2_c_references_from_head_3_notesPR.docx. Cette douleur, pour autant que je sache, hante certains designers, illustrateurs et autres gars "corrigés".
Mais même cela n'est pas si effrayant. Le principal problème est que sans danse rituelle, vous ne verrez pas le texte tel qu'il apparaîtra sur le site. Au début, il semble que ce ne soit pas un gros problème. La prise de conscience de la catastrophe survient après les premières heures passées à transférer le texte du fichier Word.
Honnêtement, je ne connais aucun convertisseur public de doc en markdown, ce que Habr accepte normalement. Je ne doute pas qu'ils existent, mais les habratextes de Yandex.Money dans Word, s'ils sont écrits, ne le sont que par certains auteurs, puis ils se transforment rapidement en marquedown.
Documents Google
Excellente chose bien connue, également gratuite. Autant que possible prêt pour la collaboration de nombreux auteurs, éditeurs et autres sympathisants. La fonctionnalité est suffisante pour tout. Nécessite un compte Google, mais qui n'en a pas maintenant?
Il est pratique de travailler dans Google Dock si plusieurs personnes écrivent différentes parties du même texte, par exemple sur le travail des API de paiement sur iOS et Android. Différents développeurs, différents blocs, paragraphes, mais tout le monde voit tout, et rien n'est perdu nulle part. Un autre avantage est l'historique des modifications.
Ici, comme dans Word, il suffit de placer les titres, puis lors de l'exportation, vous n'aurez pas à faire beaucoup de travail inutile.
Inconvénients - si vous partagez un lien vers un fichier, il est beaucoup plus facile pour lui de fuir quelque part au mauvais endroit. Mais si vous n'écrivez rien contenant le NDA, ce n'est pas grave. Tout est encore compliqué ici avec un aperçu du téléchargement, mais il y a des avantages - le transfert de texte de google-dock vers un hub est beaucoup plus facile.
Que se passe-t-il d'autre
Il existe toujours un monde incroyable de textes dans des fichiers txt avec une indentation dans trois à cinq espaces. Pour des raisons éthiques, je ne peux pas le montrer (j'ai peur de l'ouvrir moi-même), mais croyez-moi - toutes les options ci-dessus sont définitivement meilleures.
Sinon, comment améliorer votre vie
Typographe
Votre texte sera cent fois mieux si les guillemets corrects sont là, les tirets et les espaces doubles aléatoires disparaissent. Pour ce faire, il y a un typographe de studio Lebedev - téléchargez le texte là-bas, et en une seconde, vous obtiendrez un beau résultat.
Ici, un plus de la démarque est montré ici - si vous déposez l'intégralité de Google Dock ou un fichier Word créé dans l'imprimante, la sortie obtiendra toujours du texte brut. Les photos seront également perdues. Mais il n'y a pas de problème avec le démarque - la mise en page est générée après, et les images sont des liens, donc vous pouvez le faire en n'importe quelle quantité, juste le temps d'appuyer sur Ctrl + A.
Bien sûr, cela ne supprime pas la nécessité d'une vérification de texte par un bon correcteur. D'un autre côté, si vous n'écrivez pas dans les blogs d'entreprise et que vous ne partagez que des choses sur Habré, c'est une bonne aide dans votre travail.
Habraconverters
Le texte de Google Docs peut être transféré de différentes manières - à la main ou via différents convertisseurs. Je n'ai pas encore trouvé l'idéal, donc je combine généralement les fonctionnalités de deux bonnes.
Le premier est https://shirixae.imtqy.com/habraconverter-v2/ . Copiez l'intégralité de Google Dock dans la zone de texte, c'est tout. Il génère un Markdown décent si vous vous souvenez de définir les en-têtes. Il est également bon de retirer des liens vers des images de google-dock - ils doivent, bien sûr, être rechargés sur Habrastorage, mais mieux que rien.
Le second est l'extension Docs To Markdown . Génère le meilleur code de démarque, fonctionne bien avec les sauts de ligne, mais ne connaît pas les images.
Pourquoi est-ce important - si cinq personnes écrivent du texte avec des images, il s'avère assez difficile d'obtenir de tous les fichiers, qui doivent ensuite être triés, disposés dans le bon ordre et publiés.
Bien sûr, si vous vous écrivez et que tout est soigneusement numéroté et organisé en papas, téléchargez simplement sur Habrastorage.
Lorsque je modifie le texte de plusieurs auteurs, je le fais - je prends le texte du deuxième convertisseur et je télécharge à nouveau les images sur Habrastorage en utilisant les liens du premier. Cela ne semble pas super simple, mais cela fait gagner un temps infini.
Conseils utiles sur le démarque et plus
- Divisez le texte en paragraphes . S'il te plait!
- Photos sur Habrastorage . C'est évident, mais il vaut mieux répéter. Il n'y a rien de pire que d'ouvrir un article utile il y a cinq ans et de se rendre compte que les liens vers les images ont depuis longtemps mal tourné. Soit dit en passant, HS propose des liens prêts à l'emploi enveloppés dans Markdown.
- Dans la numérotation des listes, seul le premier élément est important; mettez le reste à votre guise. C'est utile si vous décidez de réorganiser les éléments de la liste par 10 éléments, mais trop paresseux pour changer les nombres.
- Tableaux - photos . Dans marqdown, des tableaux amusants qui brisent le cerveau pour la première fois, mais Habr ne sait pas comment les afficher magnifiquement - les textes dans les cellules sont transférés vers une nouvelle ligne. Mieux vaut les dessiner ailleurs et incorporer PNG.
upd. Un bon conseil des opanas des commentaires est "il est conseillé de placer un spoiler près de la table d'images (dans laquelle la table sera du texte et le lecteur pourra copier, et le robot fera face à l'indexation)". - Un nouveau dock Google est créé à l'aide du lien doc.new - ajoutez-le à la barre de favoris pour gagner du temps à chaque fois.
- Gardez les brouillons - synchronisez-les avec un nuage. Bien sûr, vous pouvez toujours obtenir la mise en page de la publication sur Habré, mais, comme le montre la pratique, elle est plus fiable.
- L'indentation entre les titres de différents niveaux est la chose la plus aléatoire au monde, au moins pour les 30 premières fois. Assurez-vous de vérifier avant la publication que le texte présente une indentation normale.
- Le HTML mélangé avec Habr-markdown peut créer des bugs amusants dans les éditeurs tiers. Par exemple, si vous utilisez la
<code/> et oubliez de la fermer correctement. Il se présente comme ceci:
Conclusions
Tous les conseils de ce post sont tirés de mon expérience personnelle. Ils ne feront que gagner du temps et des nerfs sur le travail supplémentaire qui doit être fait dans la préparation de la publication - et personne n'a annulé la rédaction d'un texte intéressant.
La pratique montre que si vous êtes intéressé à écrire sur quelque chose, ni la mise en page, ni le HTML, ni la complexité de la conversion ne vous arrêteront. Vous réussirez à remplir toutes les images, à placer les en-têtes et les balises avec vos mains, à formater le code et le message se révélera toujours bon - car, évidemment, le texte est plus important que le design. Mais personne ne se soucie de faire beau et de faire plaisir aux lecteurs. Donc, vous devez le faire.
Alors gagnez.