[Documentation] ajouter un toc sur chacune des pages

EcrituresNumeriques / stylo

Stylo est un éditeur de textes pour articles scientifiques en sciences humaines et sociales.

https://stylo.huma-num.fr

GNU General Public License v3.0

48 stars 13 forks source link

[Documentation] ajouter un toc sur chacune des pages #944

Closed RochDLY closed 10 months ago

RochDLY commented 11 months ago

Certaines pages de la documentation sont très longues, on pourrait ajouter un toc sur la droite pour pouvoir naviguer plus facilement dans les contenus : https://www.npmjs.com/package/eleventy-plugin-toc

loup-brun commented 11 months ago

Pour info, un espace «navigation» est actuellement prévu dans les gabarits, mais elle n'est simplement pas remplie, prête à accueillir une éventuelle TdM.

Capture d’écran du 2023-09-29 11-48-29

RochDLY commented 11 months ago

J'ai ajouté les plugins markdown-it et markdown-it-anchor pour créer des ancres sur les titres (réparation de certains hyperliens qui pointaient sur des titres et pré-requis pour faire le toc). J'ai également installé le plugin-toc cité précédemment.

RochDLY commented 11 months ago

Il y a une table des matières insérée avec le plugin toc via un web component (toc.webc). Il reste à améliorer le css

loup-brun commented 11 months ago

Tel que signalé en commentaires de la PR:

il serait souhaitable de colocaliser le CSS de la TDM dans le composant (et non dans docs.webc)
il est recommandé de nommer les web components avec un trait d'union (ex. page-toc.webc) pour les distinguer d'éventuels éléments HTML qui porteraient le même nom (sans trait d'union)
le CSS doit effectivement être revu à plusieurs égards (pourtant, cette fonctionnalité a été mergée sans vérification dans #939)
voir #948, qui est désormais un problème introduit par cette très grosse fusion