J'ai un projet avec plusieurs personnes et nous avons un README.md
avec un tas de Markdown à la sauce GitHub qui est rendu sur notre page GitHub. Nous avons également mis en place une branche GitHub Pages qui est hébergée sous le sous-domaine de notre organisation GitHub, et nous avons utilisé l'attribut Générateur automatique de pages en chargeant simplement notre README.md
lorsque nous avons créé notre page. Cependant, je remarque que lorsque je mets à jour notre README.md
il ne met pas à jour la page du projet. Au lieu de cela, nous devons aller dans l'onglet des paramètres GitHub et recréer la page du projet, en rechargeant le fichier README.md
quand on le fait.
Aussi, après avoir lu sur liaison relative travailler entre les fichiers de documentation sur les pages du répertoire du projet GitHub. J'aime beaucoup le format markdown car il permet de gagner beaucoup de temps en évitant d'avoir à écrire tout le HTML à la main pour notre documentation. Ce que j'aimerais cependant, c'est pouvoir disposer d'un seul fichier README.md
qui peut inclure des liens relatifs vers d'autres fichiers de documentation situés à l'adresse suivante docs/*.md
. J'espérais qu'il y avait une solution facile pour que mes autres fichiers de documentation puissent également être inclus dans ma branche gh-pages et être hébergés sous mon sous-domaine GitHub Pages et être rendus et/ou thématisés.
En d'autres termes, mes questions sont :
- Existe-t-il un moyen de mettre automatiquement à jour mon fichier README.md sur le sous-domaine de ma page Github ?
-
[ EDIT ] : Non semble être la réponse si vous utilisez le générateur automatique de pages. Vous devez vous rendre sur la page des paramètres du dépôt et la recharger chaque fois qu'une modification est apportée afin de la mettre à jour.
-
[ EDIT ] : Non semble être la réponse si vous utilisez le générateur automatique de pages. Vous devez vous rendre sur la page des paramètres du dépôt et la recharger chaque fois qu'une modification est apportée afin de la mettre à jour.
- Existe-t-il un moyen de faire en sorte que les liens relatifs à ma documentation dans mon fichier README.md fonctionnent sur mes pages Github, peut-être en synchronisant d'une manière ou d'une autre mes pages Github avec les liens relatifs à ma documentation ?
/docs/*.md
à mes pages Github et les rendre et/ou les thématiser d'une manière ou d'une autre ?-
[ EDIT ] : D'après ce que j'ai appris depuis que j'ai rédigé cette question, il semble que cela ne soit possible que sur les pages GitHub grâce à l'utilisation d'un fichier générateur de site statique comme la pierre précieuse du rubis Jekyll et probablement quelques utilisations de la webhooks supportés par GitHub qui sont mentionnés dans les commentaires ci-dessous. J'essaie actuellement de trouver une solution optimale.
-
[ EDIT ] : D'après ce que j'ai appris depuis que j'ai rédigé cette question, il semble que cela ne soit possible que sur les pages GitHub grâce à l'utilisation d'un fichier générateur de site statique comme la pierre précieuse du rubis Jekyll et probablement quelques utilisations de la webhooks supportés par GitHub qui sont mentionnés dans les commentaires ci-dessous. J'essaie actuellement de trouver une solution optimale.
- Mieux encore, y a-t-il un moyen encore plus simple de faire cela et peut-être d'avoir une seule copie de mon README.md et de ma documentation qui est utilisée à la fois sur les pages gh et sur ma branche principale et qui rend tout plus facile ?
-
[ EDIT ] : Il semble que celui-ci soit presque définitivement un non. Je pensais à la possibilité d'intégrer quelque chose dans GitHub pour permettre cela. Il semble qu'un meilleur support pour ce genre de choses pourrait être intégré dans les pages GitHub à l'avenir, ou du moins je l'espère vraiment.
-
[ EDIT ] : Il semble que celui-ci soit presque définitivement un non. Je pensais à la possibilité d'intégrer quelque chose dans GitHub pour permettre cela. Il semble qu'un meilleur support pour ce genre de choses pourrait être intégré dans les pages GitHub à l'avenir, ou du moins je l'espère vraiment.
- Donnez-moi une autre meilleure solution que vous avez.
Merci beaucoup à l'avance.
[ EDIT ] : Cette question commence maintenant à recevoir une certaine attention et je continue également à faire des recherches à ce sujet. Je suis toujours ouvert et à la recherche de la solution la plus facile/optimale, probablement en utilisant des webhooks et Jekyll ou quelque chose de similaire. Je veux donner à plus de personnes la chance de répondre avant d'accepter la meilleure. Je sais qu'il doit y avoir des tonnes d'astuces individuelles que les gens utilisent pour cela et je suis sûr que quelqu'un a une excellente solution pour faire cela facilement.