Licence CC BY

[Chronique] Zest of Dev 3

Première chronique de 2018, que s’est-il passé cette semaine sur le développement de zds? Sans plus attendre voici l’état des lieux.

Zmarkdown et la petite sirène

Le développement de zmarkdown a repris et plusieurs modifications ont été apportées :

  • victor nous a proposé de retirer le code du "serveur zmarkdown" de la partie zds-site (backend Django de zds) car ce n’est pas au projet zds-site de faire tourner ce serveur. Du coup aujourd’hui le serveur zmarkdown, qui reçoit du Markdown et retourne de l’HTML ou du Latex, est dans le paquet npm zmarkdown ;
  • Héziode a fait une PR pour s’assurer que la syntaxe personnalisée pour les codes inline (c’est à dire les codes insérés dans le texte, comme celui ci) soit intégrée à notre utilisation de rebber (le convertisseur "arbre syntaxique markdown" -> code $\LaTeX$ ) ;
  • victor a commencé à intégrer mermaid, un outil qui vous permettra d’intégrer des diagrammes à vos tutoriels simplement en écrivant du texte1. Une étape ultérieure pourrait être d’intégrer dot (graphviz), si cette syntaxe intéresse notre public.

Pour rappel ZMarkdown est un projet que nous avons initié en 2017 pour remplacer notre interpréteur de markdown (Python-ZMarkdown) que nous avions du mal à maintenir et qui manquait de souplesse, notamment lorsqu’il n’était capable que de transformer du Markdown en HTML, nous forçant à utiliser une solution tierce et particulièrement pénible pour transformer notre code markdown en latex puis en PDF.

L’idée est de passer par un écosystème open source – nommé remark – constitué de bibliothèque permettant de manipuler le markdown sous forme d’un AST Markdown, sur lequel on peut intervenir avant, pendant, après le parsing.

Parmi les possibilités offertes, une transformation indispensable pour zds est celle qui consiste à transformer le MDAST (AST Markdown) en HAST (AST HTML), pour enfin projeter l’arbre HAST en HTML pour afficher vos messages et tutoriels.

Nous avons également implémenté une projection vers LaTeX de l’AST Markdown, projet que nous avons nommé rebber.

Afin de structurer ce projet proprement et de permettre à tout le monde de bénéficier de notre travail, nous avons créé un module séparé et indépendant pour chacun des éléments de syntaxe Markdown propres à zds. Ces extensions sont open sources, disponibles sur NPM et référencées dans le projet remark.

Vous pouvez les voir ici.

Lorsqu’une extension commence par remark- cela veut dire que c’est une extension au parser markdown. Lorsqu’elle commence par rehype-, elle concerne la transformation en HTML et, enfin, si cela commence par typographic- c’est une extension d’une bibliothèque de typographie nommée textr.

  1. Pour l’utiliser de plus en plus souvent, c’est vraiment bien fichu comme truc et pas trop complexe. Par contre faudra peut être prévoir, un jour, un petit bouton dans notre éditeur pour vous aider à créer vos diagrammes. ↩

Publication PDF, partielle et mesurée

Nous avançons de plus en plus en ce qui concerne la publication des PDF.

Bien que la récente refonte des rôles entre les projet zmarkdown et zds-site a fait que nous devons clarifier qui déploie quoi (mais c’est un détail technique, autant pour nous que pour vous) nous avons désormais une pipeline de publication qui fonctionne et les premiers exemples tombent.

Autre grand chantier fonctionnel du site : les statistiques pour les auteurs. Eskimon nous propose un petit aperçu avec des vraies données (bon c’est avec son propre tuto – qui est le plus vu du site – qu’il a joué, mais on le lui pardonnera volontiers, non?).

Aperçu des statistiques.

Vous pouvez suivre le travail d’Eskimon et Anto sur le forum. Je vous encourage à y laisser quelques pouces verts pour encourage notre caribou national !

Dernière fonctionnalité qui avance : la publication partielle. Lorsque vous rédigez votre tutoriel, vous pouvez dire "cette partie n’est pas prête à être publiée" et dès lors, lorsque le validateur passera et validera votre tutoriel, celle-ci n’apparaîtra pas. Néanmoins, cela vous permettra de continuer à rédiger votre tutoriel et à prévoir son organisation.

Notons que pour l’instant la publication partielle ne concerne pas les minituto ni les articles.

Le statu de cette fonctionnalité est "Chez moi ça marche". J’ai écrit un test qui simule la navigation, mais celui-ci échoue lorsqu’il est exécuté par travis alors qu’il réussit chez moi.

Les PR de la quinzaine

ZMD:

Zds site

Latex-template

10 commentaires

Ça a sûrement été déjà évoqué quelque part, mais si je comprends bien zMarkdown est un serveur indépendant qui attend qu’on lui passe du Markdown à convertir en HTML ou en LaTeX. Quelles ont été les raisons pour que ce service soit un serveur, et pas une bibliothèque qu’on importerait dans le code de ZdS avec une simple fonction à appeler pour convertir le Markdown ?

+0 -0

Quelles ont été les raisons pour que ce service soit un serveur

principalement le fait que zds est en python et que zmd est en JS. Avant, nous utilisions une bibliothèque mais elle avait deux problèmes :

  • difficile à faire évoluer
  • peu de monde pour s’en occuper

à l’opposer autour de remark, il y a un écosystème actif et réactif, ce qui permet d’avoir des fix rapidement tout en ayant la facilité d’évolution liée au modèle technique choisi.

En soi l’utilisation d’un modèle client/serveur n’a presque pas de sourcoût et plus on avancera (notamment en ajoutant de nouvelles estensions) et plus ce surcoût sera faible voire inexistant.

+0 -0

La preuve que faire l’effort de tout implémenter en petites lib open source bien propres, bien testées, bien semver, bien documentées, c’est bien : Gatsby dépend de certains de nos paquets.

+5 -0
Connectez-vous pour pouvoir poster un message.
Connexion

Pas encore membre ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte