MDN sur Dochub

Publié le par /

DocHub est un fort pratique site qui compile de nombreuses documentations utiles pour le développement Web. Il utilise des scripts pour aspirer les sections de MDN consacrées à HTML, CSS et JavaScript, mais aussi la documentation de jQuery et PHP. L’ensemble est ensuite proposé au travers d’une interface unifiée, avec un moteur de recherche. Le site permet de stocker l’ensemble de la documentation dans le navigateur, via appcache. Cela rend la recherche et la consultation de documentation très rapide. J’ai depuis longtemps ce site épinglé dans mon navigateur, et m’en sers tous les jours.

Malheureusement, ni le code source, ni la base de documentation n’ont été mis à jour depuis plus d’un an, et le développeur semble avoir abandonné le projet. Il n’est donc plus très à jour.

MDN a quant à lui récemment reçu un coup de peinture, et la dominante bleue du nouveau thème m’horripile. Ça n’est pas très grave, car je le consulte surtout à travers l’interface de DocHub. Hormis pour toute la documentation liée à Firefox OS et aux APIs Web, qui ne figure pas sur DocHub. Mais qu’à cela ne tienne, puisque le code source est libre, il suffit de dupliquer le projet et de créer un script pour extraire de MDN les pages dont j’ai besoin.

C’est ce que je viens de faire. Je me suis basé sur une version d’Edinei Cavalcanti, qui a ajouté à DocHub la documentation de NodeJS et Python 3. Les scripts de capture de MDN ne fonctionnaient plus, donc je les ai rapidement adaptés et j’en ai créé un pour Web API. J’ai fait ça à la (r)hache et n’ai guère testé, donc je présume que c’est très truffé d’erreur. Le code de DocHub lui-même devrait être améliorable, par exemple en ne chargeant pas toute la documentation en mémoire, mais dynamiquement les extraits nécessaires. Malheureusement, je n’ai pas le temps d’aller plus loin. J’ai une instance locale qui fonctionne à peu près, je m’en contenterai pour l’instant. N’hésitez pas à tester, avoir une version locale de MDN est confortable.

Ceci dit, je trouve l’outil fort pratique. Il allie la pertinence de la documentation de MDN au confort d’utilisation et à la réactivité d’une application locale. Il mériterait de ne pas être laissé en friche. Si des bonnes âmes connaissant un peu Node.js cherchent un projet auquel donner un peu d’affection, celui-ci est un bon candidat. Avis aux volontaires… (évidemment, l’idéal serait de récupérer tout le travail effectué dans les nombreux forks déjà existants sur Github, et de mettre à disposition sur une URL publique l’application mise à jour).

Pour réagir, n'hésitez-pas à m'écrire : clochix chez clochix.net ou à soumettre l'url de votre commentaire :
(Je traite les mentions à la main, elles peuvent mettre plusieurs jours avant d'apparaître)

Si vous avez un compte Github, vous pouvez me proposer des corrections en éditant ce billet

Fork me on GitHub