Publier un cours via GitHub sur votre propre blog

Avec la crise Covid19, notre vie et nos habitudes ont complètement changé. Au moins pendant un laps de temps prévisible, il ne sera pas possible de suivre des cours en personne. En conséquence, de nombreuses personnes commencent à mettre leurs cours en ligne. Si vous souhaitez publier vos cours en ligne, il existe plusieurs façons de le faire. Dans cet article, nous allons vous montrer une solution assez simple via GitHub.

Étape 1: créer un référentiel GitHub

Pour que votre manuel soit hébergé par GitHub, vous devez faire deux choses: 1) créer un compte GitHub et 2) créer un référentiel (un espace de «mémoire» où vos fichiers seront stockés). Si vous êtes nouveau sur GitHub, vous pouvez trouver des instructions plus détaillées sur la façon de l'utiliser ici. Pour montrer mon exemple d'un cours que j'ai (Alessandro) publié (une traduction d'un manuel R), vous pouvez voir ceci dépôt et ce poste (attention, c'est en français). Des instructions plus détaillées sur la façon de travailler avec GitHub se trouvent dans cette présentation que j'ai faite dans notre groupe de cognition sociale («la hache»). Vous pouvez le télécharger ici.

Étape 2: Convertissez votre Google Doc en fichier Markdown

Afin d'être affiché par GitHub, vos fichiers doivent être au format Markdown (si vous utilisez un autre format, l'aperçu de vos fichiers ne sera pas disponible). Supposons que vous travaillez avec un Google Doc que vous souhaitez le convertir au format Markdown (je peux le recommander, car il existe des solutions intégrées).

Vous allez d'abord effectuer la conversion en suivant ces instructions:

  • Ouvrez un document Google à partir de votre lecteur Google que vous souhaitez convertir en fichier Markdown.
  • Cliquez sur Outils → Éditeur de script (vous ne pouvez le faire que si vous avez le droit de modifier le document).

Dans le Code.gs fenêtre vous trouverez cette ligne de code:

Supprimez-le, copiez-collez-le code. Le mérite de ce script va à Mangini.

  • Enregistrez le nouveau script.
  • Une fois que vous avez enregistré le script, il y aura un menu déroulant avec le titre «MyFunction» (comme vous pouvez le voir dans l'image ci-dessous).
  • Dans ce menu déroulant, sélectionnez la fonction "ConvertToMarkDown".
  • Cliquez sur le bouton "Exécuter" (la première fois que vous faites cela, vous devrez donner une autorisation)
  • Le document Google a maintenant été converti au format «.MD» (Markdown). Il sera envoyé automatiquement à l'adresse e-mail associée à votre compte Google (avec toutes les images de votre document Google jointes).

Étape 3: Correction du fichier converti

La conversion fonctionne bien dans certains cas, dans d'autres non. Par exemple, certaines tables sont bien converties, d'autres un peu moins. Alors, vérifiez votre nouveau fichier avant de le publier. Dans tous les cas, si vous avez des images, vous devrez malheureusement les ajouter à la main. Pour ajouter des images et corriger le code, il existe des outils précieux. J'en ai utilisé deux: Atome, qui est un éditeur de texte et Dillinger, qui vous permet de voir l'aperçu du fichier au format .MD. Pour ajouter des images, utilisez la ligne de code suivante:

De cette façon, vous ajouterez dans le fichier Markdown l'image appelée image_0.png. Il est recommandé d'organiser les images dans un dossier spécifique, afin de ne pas les laisser étalées dans votre référentiel GitHub. Pour faire référence à des images dans un dossier spécifique, vous pouvez utiliser la ligne de code suivante, qui doit être ajoutée dans le fichier Markdown:

Pour déballer ceci:

  • image_0.png fait référence au nom de l'image
  • "10"Est le sous-dossier du dossier nommé"images ».

Il est recommandé d'appeler le sous-dossier avec une valeur numérique correspondant à la numérotation du chapitre (c'est-à-dire 1 pour le chapitre un, 2 pour le chapitre deux, et cetera). Ainsi, avec cette ligne de code, vous affichez dans le fichier markdown, le image_0.png, situé dans le dossier "10», Qui se trouve dans le dossier nommé«images». L'exemple décrit ci-dessus ressemblera à celui du référentiel GitHub.

Voici la ligne de code du cours que j'ai posté:

Et voici ce qui était affiché pour cette partie du cours:

Parfois, lors de la conversion, certaines images sont perdues. Cela signifie que vous ne recevrez pas les images de votre document Google par e-mail. Dans ce cas, vous devez enregistrer vous-même les images à partir du document original et les placer dans le dossier que vous avez créé. Je suggère ceci Documentation pour savoir comment mieux travailler avec les fichiers au format Markdown.

Étape 4: Poussez le fichier converti sur GitHub

  • À ce stade, vous avez les fichiers convertis en Markdown et un dossier dans lequel vous avez des images qui seront affichées dans chaque fichier Markdown. Ce que vous devez faire maintenant est d'aller dans le référentiel GitHub et de pousser les fichiers dans Markdown, avec le dossier, contenant toutes vos images.
  • Vous pouvez télécharger les fichiers directement depuis le site Web GitHub ou travailler dans votre référentiel local. Lorsque cela est fait, transmettez les modifications au référentiel en ligne.

Étape 5: Intégrez la page GitHub dans votre blog

  • Maintenant que vous avez mis à jour votre page GitHub avec les fichiers dans Markdown, ils seront rendus comme ça . Ce que vous voulez faire maintenant, c'est pousser directement vers WordPress (voir par exemple ce poste). Cela peut fonctionner, mais si les phrases et les liens sont copiés à partir de GitHub, les images ne le sont pas. J'ai fait plusieurs tentatives, mais je n'ai pas pu comprendre pourquoi il ne copie pas les images.
  • La meilleure solution maintenant est d'intégrer les chapitres dans une sorte de Wiki sur notre blog avec les liens des différents chapitres qui se trouvent sur GitHub. C'est ce que j'ai fait ici.
  • Il existe peut-être une meilleure solution, plus élégante, pour que le cours lui-même soit poussé de GitHub vers WordPress, mais je n'ai pas encore pu le découvrir. Si vous connaissez une solution élégante, faites-le nous savoir via les commentaires sur ce blog.

Si vous suivez ces étapes, vous pourrez convertir votre propre cours en un cours en ligne uniquement avec Google Docs et un flux de travail relativement simple. Vous pouvez intégrer votre page GitHub dans votre blog, ce qui pourrait rendre votre cours disponible sur votre site Web personnel. Cela peut vous aider pendant ces périodes à rendre vos cours plus facilement disponibles et, à long terme, à offrir une plus grande visibilité à votre travail.

Cet article a été rédigé par Alessandro Sparacio et Hans IJzerman

Laissez un commentaire

Ce site utilise Akismet pour réduire les spams. Découvrez comment sont traitées les données de vos commentaires..

%d blogueurs comme ceci: