Table des matières:

Meilleure façon d'afficher/documenter des fichiers sur Instructables : 4 étapes
Meilleure façon d'afficher/documenter des fichiers sur Instructables : 4 étapes

Vidéo: Meilleure façon d'afficher/documenter des fichiers sur Instructables : 4 étapes

Vidéo: Meilleure façon d'afficher/documenter des fichiers sur Instructables : 4 étapes
Vidéo: Comprendre SharePoint en 5 Étapes simples et rapides 2024, Novembre
Anonim

Les gens y incluent souvent des fichiers pour le projet via les téléchargements Instructables.

Il s'agit souvent de fichiers source de logiciels qui peuvent même être le cœur battant de l'instructable. Mais Instructables ne donne pas au lecteur un moyen facile de lire et de revoir le code. (généralement, vous devrez télécharger le code, éventuellement le décompresser, puis trouver le bon programme de visualisation.) Souvent, le code que j'ai trouvé s'avère ne pas en valoir la peine. Que diriez-vous d'une méthode en un clic (+- 2) pour visualiser les programmes ? C'est ainsi.

(Image ci-dessus de:

Outils et fournitures:

  • Ordinateur
  • Compte public gratuit GitHub

Étape 1: Affichage de l'ancien style

Affichage de l'ancien style
Affichage de l'ancien style

Il y a quelque temps, j'ai écrit un instructable sur un terminal intelligent à utiliser avec des Arduinos et d'autres microcontrôleurs. Vous pouvez le voir ici: Terminal Python pour une connexion Pi Arduino bon marché

La section des fichiers ressemble principalement à l'image ci-dessus, si vous cliquez sur les fichiers, vous obtenez un téléchargement avec un nom de fichier mutilé et devez faire une petite danse informatique pour l'ouvrir et le lire. Ensuite, vous devez garder une trace du fichier sur votre ordinateur.

Étape 2: Affichage du nouveau style

Affichage du nouveau style
Affichage du nouveau style

Ici, vos fichiers de code ressemblent à du code. Les fichiers-p.webp

Comment faire:

Ajoutez simplement un lien vers votre dépôt github. et une fois rendu par instructables, cela ressemble à:

Fichiers GitHub du projet

Dans l'étape suivante, nous avons quelques images détaillées de l'ajout du lien à partir de l'éditeur d'instructables.

Étape 3: Insérez le lien (Détails)

Insérer le lien (Détails)
Insérer le lien (Détails)
Insérer le lien (Détails)
Insérer le lien (Détails)
Insérer le lien (Détails)
Insérer le lien (Détails)
Insérer le lien (Détails)
Insérer le lien (Détails)
  • Image 1: Cliquez sur l'icône de lien (en surbrillance).
  • Image 2: Vous obtenez la boîte de dialogue de lien.
  • Image 3: Remplissez la boîte de dialogue.
  • Image 4: Et vous obtenez un joli lien dans votre instructable.

Si tout le monde le faisait, il serait tellement plus facile de visualiser le code (et d'autres types de fichiers, et même de télécharger l'ensemble des fichiers sous forme de joli fichier zip avec les noms internes et la structure de répertoire préservés.

J'aime tellement ça que je vais revenir en arrière et réparer tous mes anciens instructables !

Étape 4: Liens connexes

  • https://www.instructables.com/id/Include-Code-in-an-Instructable/
  • https://www.instructables.com/id/Introduction-to-GitHub/
  • https://www.instructables.com/id/Downloading-Code-From-GitHub/
  • Terminal Python pour une connexion Pi Arduino bon marché

Conseillé: