Créer localement un docset Aurelia pour Zeal (gestionnaire offline de doc)

Zeal est une application Linux, Windows permettant de regrouper localement des documentations techniques telles que HTTP, CSS, HTML, Java, Reactjs … Ainsi plus besoin de ce connecter sur le Web (on a pas toujours accès à internet 😉
Bien que sa bibliothèque soit bien fournie (195 documentations), elle ne contient pas la documentation d’Aurelia (Aurelia.io).
Cependant, il existe un moyen de créer sa propre documentation Aurelia pour Zeal.

Pour créer le « docset » Zeal, i faut récupérer localement le projet « Aurela-docset » qui se trouve sur GitHub :

git clone https://github.com/riddla/aurelia-docset.git

Maintenant dans le dossier « Aurelia-docset » vous avez un dossier « aurelia.docset ». Soit vous le régénérez soit vous le gardez tel quel.

Si vous voulez régénérer, il vous faut avoir installé les applications nodejs, npm et gulp. Puis lancer la commande d’installation des packages complémentaire :

npm install

Puis lancer la commande de création du « docset » :

gulp convert

Puis dans le dossier « aurelia.docset »

  • il faut créer deux icônes au format PNG, « icon.png » et « icon@2.png » de taille respective 16×16 pixels et 32×32 pixels .
  • créer un fichier « meta.json » dans lequel vous écrirez :
{
    "name": "Aurelia",
    "revision": "0",
    "sourceId": "aurelia-riddla",
    "title": "Aurelia",
    "version": "0.9"
}

Recopier le dossier « aurelia.docset »  dans le dossier « docset » de Zeal. Pour trouver l’emplacement de se dossier lancer Zeal puis menu « Edit/preferences » onglet « General » champ « Doset storage » (en bas) :Zeal parametresLancer Zeal , la documentation d’Aurelia s’affiche :

Zeal et Aurelia