Héberger un Tiddlywiki sur Github (sans connaissance de Git)


#1

Suite du sujet Hébergement De TiddlyWikis:

Voici la traduction FR pour héberger un Tiddlywiki sur Github


Prérequis

La liste des prérequis est assez courte, et vous avez besoin de les réaliser une seule fois :

  • Un compte Github
  • Un compte Travis-ci

Première configuration

Voici les étapes nécessaire pour la première configuration. Une fois faite, il sera très rapide
d’ajouter un nouveau wiki.

Configuration de Github

  1. Nous devons créer un jeton Personal access token pour autoriser nos script à publier sur notre compte github. C’est nécessaire seulement la première fois. Aller à la page de gestion des jetons : Github’s tokens management page
  2. Créer un nouveau jeton en cliquant sur Generate new token
  3. Donner une description significative au jeton. C’est très important car elle sera la seule clé qui vous permettra d’identifier le jeton.
  4. Vérifier que les options repo et public_repo sont sélectionnées.
  5. Cliquer sur Generate token.
    Voici à quoi ressemble cette étape.
    Image
  6. Github générera un jeton unique. Noter le bien tout de suite car vous n’aurez pas d’autre occasion de la faire.

Créer le premier wiki

  1. Forker le dépot. Cette étape sera nécessaire pour chaque wiki. Comme promis , vous pouvez faire cela directement depuis Github, Il suffit de cliquer sur le bouton en haut à droite de cette page.
  2. Une fois le dépôt copié, vous pouvez le renommer comme bon vous semble.
  3. Allez sur le site Travis-ci and connectez-vous en utilisant votre compte Github.
  4. Si c’est la première fois que vous utilisez Travis , autoriser simplement l’application à accéder à votre compte Github.
  5. Une fois connecté à votre compte Travis, vous serez dirigé vers votre tableau de bord.
  6. Sur la gauche de votre tableau de bord, vous devez avoir une liste des dépots gérés par Travis. Au début cette liste est vide.
  7. Cliquez sur le signe + (à coté de My Repositories) pour mettre votre dépôt forké dans le gestionnaire de Travis.
  8. Vous serez redirigé sur votre profile. La , vous devez trouver la dépôt que vous avez forké, et l’activer en cliquant sur le bouton devant le nom (croix grise qui devient un coche verte). Ca devrait être facile , car Travis fournit une explication avec des copies d’écrans.
  9. Si vous ne trouvez pas les dépôts que vous cherchez, cliquez sur le bouton Sync pour rafraîchir la liste.
  10. Dans notre exemple , nous activons ce dépôt :
    https://github.com/danielo515/TW5-auto-publish2gh-pages/raw/screenshots/Travis-CI_activate.png?raw=true
  11. Maintenant il est temps de configurer les variables globales utilisées par notre script. Pour cela, cliquez sur l’engrenage, à coté du bouton d’activation.
    https://github.com/danielo515/TW5-auto-publish2gh-pages/raw/screenshots/Travis-CI_config.png?raw=true
  12. Vous êtes dans la page des Paramètres du dépôt. Laissez les options générales par défaut.
  13. Dans la section des variables d’environnements, nous allons ajouter les variables nécessaires.
    i. D’abord ajoutez GH_REF, qui est l’url de votre dépôt forké, sans le préfix https:// et
    avec une extension .git. Pour cette variable , vous pouvez activer (on) le Display value in build log, ainsi vous pourrez vérifier que c’est correct pour chaque build. Cliquer sur Add
    https://github.com/danielo515/TW5-auto-publish2gh-pages/raw/screenshots/Travis-CI_GH_REF.png?raw=true
    ii. . Faites de même pour ajouter la variable GH_TOKEN, mais cette fois , assurer vous que la Display value in build log n’est pas activé (OFF). Collez ici le jeton Github crée précédemement .
    iii. Suivez la même procédure pour la variable GH-EMAIL. C’est l’email que vous utilisez dans votre compte github. Après ces étapes vous devez avoir quelque chose comme ça.
    https://github.com/danielo515/TW5-auto-publish2gh-pages/raw/screenshots/Travis-CI_Variables.png?raw=true
    iv. Les modifications sont enregistrées automatiquement, donc à ce stade, nous avons terminé la configuration et nous pouvons revenir à l’onglet current .
  14. Cliquez sur l’onglet current pour voir ce qui se passe dans la phase de construction. Le process de construction se déroule à chaque fois que vous poussez une modification dans votre dépôt, et pas avant. Les construction en cours ressemble à cela :
    https://github.com/danielo515/TW5-auto-publish2gh-pages/raw/screenshots/Travis-CI_Building.png?raw=true
  15. Maintenant vous êtes prêt.
    Modifier n’importe quel fichier ou créer un nouveau fichier dans votre dépôt forké, et poussez les modifications pour déclencher une construction. Vous pouvez le faire directement dans Github. Pour plus de détails sur ce process , voire la section Modifier les tiddlers.
  16. Quand la construction s’est terminé avec succès, vous pouvez visiter l’url : <votre-nom-git>.github.io/<votre-nom-de-dépot>, pour voir la résultat.

Créer un autre wiki.

Une fois la première configuration terminée, il est plus facile de configurer un
autre wiki. Voici le résumé des étapes :

  1. Forker ce dépôt
  2. Renommer le dépôt comme vous le souhaitez.
  3. Aller sur Travis-ci et connectez-vous avec votre compte github.
  4. Dans le tableau de bord, sur la gacuhe, Cliquez sur le signe + à coté de My Repositories pour mettre votre dépôt forké dans le gestionnaire de Travis.
  5. Trouvez le dépôt que vous venez de forker et activez le en cliquant sur le bouton d’activation.
  6. Si vous ne trouvez pas votre dépôt, cliquez sur le bouton Sync pour rafraichir la liste des dépôt.
    7 Configurer les variables globales.
  7. Modifier/ Ajouter vos tiddlers et faite un push. Ceci peut être fait directement depuis github.

Modifier les tiddlers

Vous pouvez modifier ou ajouter de nouveaux tiddler , directement dans github, ce qui est assez pratique, ou vous pouvez utiliser une editeur Markdown. La syntaxe de tiddlywiki n’est pas exactement celle de Markdown, mais reste suffisamment proche. Les editeurs Markdown vous aide à compléter les listes et fournissent un aperçu.

Vous pouvez utiliser Prose, qui est l’outil utilisé par Danielo pour écrire ce guide.

Prose

  1. Aller sur le site http://prose.io/
  2. Vous devez lié Prose avec votre github, pour pouvoir modifier et enregistrer les fichier de vos dépots.
  3. Cliquez sur authorize on Github et Authorize aplication
  4. Une fois que vous avez autorisé l’application, vous pouvez commencer à créer et modifier les tiddlers.
    i. Sélectionnez le dépôt de votre wiki.
    ii. Aller dans le dossier wiki> tiddlers
    iii. Sélectionner le tiddler à modifier ou créer un nouveau fichier. Si vous créer un nouveau fichier, assurer vous qu’il a une extension en .tid.
    iv. Quand votre tiddler est modifié, cliquez sur Save . Vous pouvez ajoutez un commentaire pour le commit si besoin.

Dilinger

Pour éditer les fichiers Markdown, Dillinger est une meilleur alternative. L’inconvenient, c’est
qu’il ne reconnait que les fichiers avec l’extensions .md :

  1. Allez sur http://dillinger.io/
  2. Vous pouvez le lier à Github pour modifier et enregistrer les fichiers dans votre dépôt.
  3. Pour pouvoir enregistrer une tiddler de github, vous devez d’abord l’importer. La première fois vous devez autoriser l’application.
    i. Cliquez sur IMPORT FROM
    ii. Dans le menu sélectionnez Github
    iii. Autorisez l’application
    iv. Cliquez à nouveau sur IMPORT FROM pour sélectionnez le dépôt à modifier puis sélectionnez la branche Master
    v. Allez dans le dossier wiki> tiddlers.
    vi. Sélectionnez le tiddler à modifier.
  4. Quand votre tiddler est prêt, cliquez sur SAVE TO et sélectionnez github.

#2

Merci @fab13n pour cette traduction :fr:

La question que je me pose, est-ce que tu as réussi à suivre les consignes et confirme tu la promesse !? :yum:


#3

Ah, ah bonne question.

  • réussir à suivre les consignes ? : oui, pas de soucis pour publier le tiddlywiki fourni par Danielo et modifier l’existant.
  • confirmer la promesse ? : oui …presque…pas besoin de savoir bien utiliser Git , mais quand même avoir un minimum de vocabulaire (fork, commit, repository, branch…) pour ne pas être perdu.

Par contre, pour aller plus loin que le tutoriel, je coince sur les points suivants.

Usage

Il s’agit d’une solution de publication. Le tiddlywiki publié sur l’url de github ne sera pas modifiable en ligne (1) . Les tiddlers sont donc modifiés dans github. Travis se charge de “compiler” tous les fichiers .tid pour créer le fichier .html.
exemple de brouillon : http://fabb13n.github.io/TW5-auto-publish2gh-pages/

(1) du coup , je ne vois pas comment enregistrer les modifications du panneau de configuration ???

créer un nouveau fichier .tid

Le tiddler doit avoir certaines lignes d’en-tête, sinon il ne sera pas visible dans le html final. (mais je n’ai pas trouvé la liste précise)

  • type: text/vnd.tiddlywiki
  • title: HelloThere

importer un fichier .tid

Est-ce qu’il est possible d’importer un tiddler déja existant ?

Créer un nouveau tiddlywiki

Je n’ai pas réussit à forker mon dépot en cliquant sur le bouton fork , ni à forker une deuxième fois celui de Danielo ?


#4

Sacré travail @fab13n merci pour toutes ces infos! Il va falloir que j’essai ça!! ++