Lundi matin, il pleut, tempête sur l’ouest, qui arrive par la frange dans le coin ; retour humide probable ce soir.
J’ai testé MkDocs hier, assez satisfaisant avec peu d’installation préalable — il a tout de même fallu que je le réinstalle via Pip plutôt que via Brew, pour pouvoir ensuite installer quelques extensions plutôt pratiques —, un réglage aisé et un mode opératoire plutôt simple puisqu’on peut suivre en temps réel dans un navigateur les modifications apportées dans le source de la doc.
Du coup j’ai commencé par écrire celle du plugin Yash, histoire de me faire une idée complète. Ça demande du boulot, essentiellement de rédaction, mais une fois écrite, la création du site statique correspondant est rapide et facile.
Maintenant j’hésite encore à intégrer la doc (sources et éventuellement site statique) dans les archives des plugins, ou alors de les mettre à disposition dans un sous-domaine sur Open-Time.
Par exemple pour Yash, la documentation (pas tout à fait terminée) pèse 870 Ko dont 614 pour le site statique — et je me suis limité à une seule version en anglais — sachant que l’archive du plugin fait actuellement 111 Ko (sans la doc donc), ce n’est pas anodin.
Sinon j’ai commencé à regarder comment « industrialiser » un peu la génération d’un plugin distribué — jusqu’à maintenant je ne minifie pas les CSS/Js, … — avec Make, Grunt, Gulp, … Mais là encore, pas encore décidé, il y a du pour et du contre dans chacune des solutions, voire utiliser un simple script Bash.
Bien sûr tout ça avec en tête l’idée d’appliquer ça un jour sur Dotclear et Clearbricks — il y a de quoi générer pas mal de doc de façon automatique en plus, entre autre avec les behaviors.
À suivre…
Je viens d’intégrer la doc de Yash ici-même, pour me faire une idée. Va falloir que j’industrialise la production vu le nombre de plugins que je gère, le sommaire des docs dispos ne reflète pas encore celles qui devraient l’être dans le futur !
Après avoir fini d’écrire la doc de Yash, celle-ci pèse dorénavant 1,6 Mo, dont 963 Ko pour le site statique.
1 De Gvx -
Le lien ne mène pas a la bonne page:
Mauvais lien : https://open-time.net/docs/yash/
Bon lien : https://open-time.net/docs/plugins/…
2 De Nicolas -
Le lien “ici-même” est cassé : il manque le morceau plugins entre doc et yash
3 De Franck -
Ah oui merci, je vais corriger. Je me suis dit que tant qu’à faire, autant faire bien dès le début et organiser ça proprement ;-)
4 De Franck -
Gvx désolé, ton commentaire était resté dans les spams (Akismet l’avait écarté). J’ai corrigé le lien depuis, merci.