Page de documentation standard?

Bonjour,

La documentation du plugin-mymodbus est sur un dépot Github séparé (je ne sais pas pourquoi). En édition en ligne du markdown, tout est affiché correctement :

  • les icônes :warning: :warning: et autre
  • les tableaux ne prennent pas toute la largeur de la page

image

Par contre, sur la page de documentation, c’est une toute autre musique…
https://bebel27a.github.io/jeedom-mymobdus.github.io/fr_FR/index_b

image

Et les tableaux prennent toute la largeur.

Ca vient du fichier _layouts/default.html ?
Est-ce qu’il existe un template de base pour la documentation ? Avec gestion Dark/Normal tant qu’à faire…
La documentation officielle de création d’un plugin ne détaille pas ce point.

Vous pouvez m’indiquer un plugin et son git où c’est géré correctement SVP ?

A+
Michel

Bonjour,

J’ai la même question :slight_smile: est-ce qu’on peut reprendre le layout de la doc officielle telle quelle pour notre propre plugin ?

Peut-on ajouter notre doc de plugin dans la section « plugins contributeur » ?
https://doc.jeedom.com/fr_FR/plugins_contributor/devicecommunication/

a un moment c’était presque encouragé :wink:

En principe tu as une case à cocher dans la config du plugin (dans le market)
image

par contre pour certains plugins ça fonctionnent, pour d’autres pas.
Je n’ai jamais compris pourquoi; ils ont pourtant la même configuration.

edit: du coup je viens d’aller vérifier et je me rend compte que pour bcp de mes plugins c’est bon à présent, il y a donc eu des corrections la-dessus manifestement :slight_smile:

La case est bien cochée sur mon plugin, mais il n’apparait pas dans la doc Jeedom (plugin LGThinq dans la catégorie des objets connectés)
Je n’ai pas configuré de token mais le bot jeedom-market est bien collaborator sur le plugin. Est-ce qu’il doit faire des PR ou autre dans notre repo pour que la doc soit affichée sur le site Jeedom ?

Non aucun pr.
Moi ça fonctionne pour tout ceux pour lequel le token est configuré.
J’ai corrigé la config des derniers et en principe ça sera mis à jour la nuit prochaine

Ceci dit pour afficher le plugin dans la doc aucun accès ne serait nécessaire puisque toute l’info est dans le info.json.
Je suppose que ça date du temps ou les traductions pouvaient être faites sur les plugins par le market?

Salut,

Réponse rapide depuis les vacances…

Sur github en cherchant le plugin Klereo de Mrwaloo (moi), vous trouverez un début de plugin avec le répertoire Doc qui est basé sur la doc Jeedom.

A+
Michel

Bonjour,

je me permets un petit up parce qu’il se trouve que la documentation sur un repo github non privé induit le même phénomène, à savoir que sur github lors du preview de la page d’aide, les balises du type :warning: sont affichés avec une icône « point d’exclamation » mais sur la page de doc, ce n’est pas interprété et affiché tel quel.

Git :

image

Doc :
https://mrwaloo.github.io/jeedom-klereo/fr_FR/beta/index
image

Je n’y connais quasi rien en markdown et je vous demande votre aide pour avoir le même résultat.

Bonjour,

Copier le symbole sur la preview Github :
image
Coller le symbole dans votre éditeur de code :
image
Et pousser le changement :
image
Je n’ai malheureusement pas d’explication technique, :warning: ne fonctionne pas non plus sur une Github Page classique, le code HTML (⚠) fonctionne mais pas de couleur :
image

Salut,

La vrai question c’est pourquoi cela devrait fonctionner?
C’est documenté chez github?
Ton preview n’est pas github, pas le même moteur, donc aucune garantie que ça donne le même résultat surtout pour de la syntaxe hors standard markdown.

Si c’est sensé fonctionner je pense qu’il faut plutôt chercher dans la doc et sur le support de github.

Bonjour,

La nuit porte conseil, il faut installer un plugin Jekyll pour que le code des émojis soit interprété :

image
image

Pour info., il existe également un plugin pour la preview Markdown de VS Code :

1 « J'aime »

Aaahhhh, ça semble être la solution.
Je testerai ça ce soir chez moi, là je n’ai pas forcément tous les accès, et je ferai un retour.

Edit: testé sur la version en ligne directement et ça fonctionne.

Un grand merci à @Spine

Ce sujet a été automatiquement fermé après 24 heures suivant le dernier commentaire. Aucune réponse n’est permise dorénavant.