Markdown - Aide-mémoire
Vous pouvez utiliser le balisage Markdown pour améliorer la lisibilité d'un fichier readme ou des cellules Markdown dans les blocs-notes Jupyter. Les différences relatives à Markdown dans les fichiers Readme et dans les blocs-notes sont notées.
En-têtes : Utilisez #s suivi d'un espace vide pour les titres de bloc-notes et les en-têtes de section :
#
titre##
en-têtes majeurs###
Sous-positions
####
Sous-titres de niveau 4
Accent : Utilisez ce code : Gras : __string__
ou **string**
, Italique : _string_
ou *string*
, barré : ~~string~~
Symboles mathématiques : Utilisez ce code : $ mathematical symbols $
Police à espacement fixe: Placez le texte entre guillemets simples (`). Utilisez une police à espacement fixe pour les chemins de fichier et les noms de fichier et pour les utilisateurs de texte que les utilisateurs de texte saisissent ou que les utilisateurs de texte de message voient.
Les retours à la ligne: Parfois Markdown ne fait pas de retours à la ligne lorsque vous le souhaitez. Placez deux espaces à la fin de la ligne ou utilisez ce code pour un retour à la ligne manuel : <br>
Citation indentée : Utilisez un signe supérieur à (>
), puis un espace, puis entrez le texte. Le texte est en retrait et comporte une ligne horizontale grise sur sa gauche jusqu'au retour chariot suivant.
Puces : Utilisez le signe du tiret (-
) avec un espace après lui ou un espace, un tiret et un espace (-
) pour créer une puce circulaire. Pour créer une sous-puce, utilisez une tabulation suivie d'un tiret et d'un espace. Vous pouvez aussi utiliser un astérisque à la place d'un tiret.
Listes numérotées : Commencer par 1.
suivi d'un espace, puis de votre texte. Le retour chariot et la numérotation sont automatiques. Commencez chaque ligne par un nombre et un point, puis un espace. Appuyez sur la touche de tabulation pour effectuer une mise en retrait et obtenir la sous-numérotation.
Case à cocher dans les fichiers Readme: Utilisez ce code pour une case non cochée: - [ ]
Utilisez ce code pour une case cochée: - [x]
Tableaux dans les fichiers readme : Utilisez ce code :
| Heading | Heading |
| ----| ----|
| text | text |
| text | text |
Graphiques dans les cahiers : Faites glisser les images vers la cellule Markdown pour la connecter au bloc-notes. Pour ajouter des images à d'autres types de cellule, utilisez des graphiques hébergés sur le Web avec ce code, en remplaçant Url / nom par l'URL complète et le nom de l'image : <img src="url/filename.gif" alt="Alt text" title="Title text" />
Graphiques dans les fichiers readme : Utilisez ce code : ![Alt text](url/filename.gif "Title text")
Formes géométriques: Utilisez ce code avec un numéro de référence décimal ou hexadécimal à partir d'ici: UTF-8 Formes géométriques &#reference_number;
Lignes horizontales : Utilisez trois astérisques : ***
Liens internes : Pour accéder à une section, ajoutez un point d'ancrage au-dessus du titre de la section, puis créez un lien.
Utilisez ce code pour créer un ancrage: <a id="section_ID"></a>
Utilisez ce code pour créer le lien: [section title](#section-ID)
Vérifiez que section_ID est unique dans le bloc-notes ou le fichier Readme.
Pour les blocs-notes, vous pouvez également ignorer la création d'ancres et utiliser le code suivant: [section title](#section-title)
Pour le texte entre parenthèses, remplacez les espaces et les caractères spéciaux par un trait d'union et mettez tous les caractères en minuscules.
Testez tous les liens !
Liens externes : utilisez le code suivant :
[link text](http://url)
Pour créer un lien qui s'ouvre dans une nouvelle fenêtre ou un nouvel onglet, utilisez ce code : <a href="http://url" target="_blank" rel="noopener noreferrer">link text</a>
Testez tous les liens !
Rubrique parent: Projets