Test KitDocs qui est basé sur SvelteKit

[stephane-klein]

Test KitDocs qui est basé sur SvelteKit.

Mes tests sont effectués dans : https://github.com/stephane-klein/kit-docs-playground

Todo :

• [x] Tester le support du placement des ressources markdown dans un dossier parent (mono repo)
• [x] Tester le support de TOC sur des pages markdown
• [x] Tester le support page précédente / suivante
• [ ] Tester le support i18n, idéalement cette structure d'organisation de fichiers

  /docs/page1.md
  /docs/page1.fr.md
  ...

• [ ] Tester l'intégration d'un moteur de recherche static (du style Lunrjs ou Stork (qui semble plus moderne))
• [ ] Tester la possibilité d'implémenter des pages en SSR

[stephane-klein]

Tester le support du placement des ressources markdown dans un dossier parent (mono repo)

Fait, ça marche (voir cette version).

À noter :

• il est important de créer un lien symbolic de docs/ vers services/kit-docs/src/routes/docs/ et non l'inverse, sinon, la résolution des chemins relatifs par SvelteKit ne fonctionne plus.

[stephane-klein]

Tester le support de TOC sur des pages markdown

J'ai ajouté plusieurs paragraphe avec différents niveaux de titres dans services/kit-docs/src/routes/docs/[...1]first-category/[...1]first-page.md et voici le résultat :

Il n'y a pas de section TOC.

[stephane-klein]

Il n'y a pas de section TOC.

J'ai sans doute eu un problème de "refresh", j'ai changé et page et je suis revenu et j'ai bien la section OnThisPage qui est présent dans la page, voici ce que cela donne :

[stephane-klein]

Tester le support du placement des ressources markdown dans un dossier parent (mono repo)

Je constate quelque chose qui ne me plait pas en mode monorepo avec l'utilisation du lien symbolic :

Voici ce que je vois quand sous GitHub je vais dans le dossier main/docs/ :

Cela ne correspond pas à mon souhait, je souhaite qu'un développeur puisse à la fois consulter la documentation Markdown via GitHub ou GitLab et en plus via le site web généré par la documentation.
Pour le moment, le lecteur est obligé d'aller dans un sous répertoire profond du monorepo pour consulter la documentation 😔

[stephane-klein]

• [ ] Tester le support i18n, idéalement cette structure d'organisation de fichiers

  /docs/page1.md
  /docs/page1.fr.md
  ...

https://github.com/svelteness/kit-docs/issues/26

[stephane-klein]

Je me pose cette question : https://github.com/sveltejs/kit/discussions/5452

[stephane-klein]

• [ ] Tester le support i18n, idéalement cette structure d'organisation de fichiers

  /docs/page1.md
  /docs/page1.fr.md
  ...

svelteness/kit-docs#26

Je travaille sur cette partie dans https://github.com/stephane-klein/kit-docs-playground/issues/1