1 line
14 KiB
Plaintext
1 line
14 KiB
Plaintext
{"cells":[{"metadata":{},"cell_type":"markdown","source":"# Guide d'utilisation Markdown\n\n## Introduction\n\nMarkdown est un _langage de balisage_ simple créé en 2004 par John Gruber avec l'aide d'Aaron Swartz. \n\nEn informatique, les langages de balisage représentent une classe de langages spécialisés dans l'enrichissement d'information textuelle. L'inclusion de balises permet de transférer à la fois le contenu et des indications sur la mise en forme (mise en italique, gras...).\n\nLe HTML est un autre langage de balisage. Le Markdown est un langage plus simple à appréhender; son apprentissage facilitera celui de l'HTML.\n\n\n\nIl a été créé dans le but d'offrir une syntaxe facile à lire et à écrire. \n\nUn document balisé par Markdown peut être lu en l'état sans donner l’impression d'avoir été balisé ou formaté par des instructions particulières.\n\n## Usages\n\nLe langage de balisage léger Markdown est utilisé dans de nombreuses applications, que ce soit dans des logiciels/éditeurs de code, des logiciels d'écriture, des plateformes de code, ou encore dans des chaînes d'édition avec l'addition d'autres logiciels. Les domaines concernés peuvent être le développement informatique, la rédaction de documentation technique ou encore la publication académique.\n\nCertains sites comme __discord__ permettent la gestion et l'affichage de texte au format Markdown.\n\nLa plupart des cours de NSI sont au format mardown, stocké sous la forme de fichier portant l'extension .md ou .ipynb.\n\nPour ouvrir, modifier ou visualiser les fichiers, il faut utiliser :\n\n- markdown (`.md`), il faut utiliser le logiciel [Typora](https://typora.io/) ou le logiciel en ligne [stackedit](https://stackedit.io/app#),\n- notebook (`.ipynb`), il faut utiliser le logiciel en ligne [Basthon](https://notebook.basthon.fr/)\n\n\n## Formatage\n\nL'emphase est l'exagération d’un mot ou d'une phrase en utilisant un style ou une fonte différente de celle du reste du texte — pour mettre l’accent dessus.\n\nEn markdown, l'emphase se manifeste par les caractères _ utilisés en paire.\n\n### Italique\n\nPour mettre une partie de texte en italique, il faut l'encadrer par un _.\n\n<u>Exemple</u> : Cette _partie du texte_ est en italique.\n\nEst obtenu par la syntaxe :\n```markdown\nCette _partie du texte_ est en italique\n```\n\n### Gras\n\nPour mettre une partie de texte en gras, il faut l'encadrer par un double __.\n\n<u>Exemple</u> : Cette __partie du texte__ est en gras.\n\nEst obtenu par la syntaxe :\n```markdown\nCette __partie du texte__ est en gras`\n```\n\n#### Remarque\n\nIl est possible de cumuler le formatage de texte.\n\n<u>Exemple</u> : Cette ___partie du texte___ est en italique et en gras.\n\nEst obtenu par la syntaxe constituée d'une paire de triples _\n```markdown\nCette ___partie du texte___ est en italique et en gras\n```\n\n\n### Paragraphe et saut de ligne\n\n\nPour faire un nouveau paragraphe, sauter deux lignes, c'est à dire laisser une ligne vide entre les deux paragraphes. Sauter une seule ligne dans le texte d'origine n'aura aucun effet à l'affichage (l'affichage sera en continu).\n\n<u>Exemple</u> :\n\nPremier Paragraphe\nDeuxième Paragraphe\n\nEst obtenu par la syntaxe suivante :\n```markdown\nPremier Pragraphe\nDeuxième Paragraphe\n```\n\n<u>Exemple</u> :\n\nPremier Paragraphe\n\nDeuxième Paragraphe\n\nEst obtenu par la syntaxe suivante :\n```markdown\nPremier Pragraphe\n\nDeuxième Paragraphe\n```\n\n### Citation\n\nIl est possible de faire des citations, c'est-à-dire formater le texte dans un style particulier différent du reste du texte, en utilisant le symbole > en début de phrase. \nLe texte est mis avec espace et une barre verticale afin de symboliser la citation.\n\n<u>Exemple</u> :\n\n> Moi, Monsieur, si j’avais un tel nez, il faudrait sur le champ que je l’amputasse !, Edmond Rostand / Cyrano de Bergerac\n\nEst obtenu par la syntaxe suivantes :\n```markdown\n> Moi, Monsieur, si j’avais un tel nez, il faudrait sur le champ que je l’amputasse !, Edmond Rostand / Cyrano de Bergerac\n```\n\n#### Citation sur plusieurs lignes\n\nIl est possible de faire une citation sur plusieurs lignes. Dans ce cas, il faut utiliser le symbole > à chaque début de lignes constituant la citation.\n\n<u>Exemple</u> :\n\n> Ah ! non ! c’est un peu court, jeune homme !\n>\n> On pouvait dire… Oh ! Dieu ! … bien des choses en somme…\n>\n> En variant le ton, – par exemple, tenez :\n>\n> Agressif : « Moi, monsieur, si j’avais un tel nez,\n>\n> Il faudrait sur-le-champ que je me l’amputasse ! »\n>\n> Amical : « Mais il doit tremper dans votre tasse\n>\n> Pour boire, faites-vous fabriquer un hanap ! »\n>\n> Descriptif : « C’est un roc ! … c’est un pic ! … c’est un cap !\n>\n> Que dis-je, c’est un cap ? … C’est une péninsule ! »\n>\n> Curieux : « De quoi sert cette oblongue capsule ?\n>\n> D’écritoire, monsieur, ou de boîte à ciseaux ? »\n>\n> Gracieux : « Aimez-vous à ce point les oiseaux\n>\n> Que paternellement vous vous préoccupâtes\n>\n> De tendre ce perchoir à leurs petites pattes ? »\n>\n> Truculent : « Ça, monsieur, lorsque vous pétunez,\n>\n> La vapeur du tabac vous sort-elle du nez\n>\n> Sans qu’un voisin ne crie au feu de cheminée ? »\n>\n> Prévenant : « Gardez-vous, votre tête entraînée\n>\n> Par ce poids, de tomber en avant sur le sol ! »\n>\n> Tendre : « Faites-lui faire un petit parasol\n>\n> De peur que sa couleur au soleil ne se fane ! »\n>\n> Pédant : « L’animal seul, monsieur, qu’Aristophane\n>\n> Appelle Hippocampéléphantocamélos\n>\n> Dut avoir sous le front tant de chair sur tant d’os ! »\n>\n> Cavalier : « Quoi, l’ami, ce croc est à la mode ?\n>\n> Pour pendre son chapeau, c’est vraiment très commode ! »\n>\n> Emphatique : « Aucun vent ne peut, nez magistral,\n>\n> T’enrhumer tout entier, excepté le mistral ! »\n>\n> Dramatique : « C’est la Mer Rouge quand il saigne ! »\n>\n> Admiratif : « Pour un parfumeur, quelle enseigne ! »\n>\n> Lyrique : « Est-ce une conque, êtes-vous un triton ? »\n>\n> Naïf : « Ce monument, quand le visite-t-on ? »\n>\n> Respectueux : « Souffrez, monsieur, qu’on vous salue,\n>\n> C’est là ce qui s’appelle avoir pignon sur rue ! »\n>\n> Campagnard : « Hé, ardé ! C’est-y un nez ? Nanain !\n>\n> C’est queuqu’navet géant ou ben queuqu’melon nain ! »\n>\n> Militaire : « Pointez contre cavalerie ! »\n>\n> Pratique : « Voulez-vous le mettre en loterie ?\n>\n> Assurément, monsieur, ce sera le gros lot ! »\n>\n> Enfin parodiant Pyrame en un sanglot :\n>\n> « Le voilà donc ce nez qui des traits de son maître\n>\n> A détruit l’harmonie ! Il en rougit, le traître ! »\n>\n> – Voilà ce qu’à peu près, mon cher, vous m’auriez dit\n>\n> Si vous aviez un peu de lettres et d’esprit\n>\n> Mais d’esprit, ô le plus lamentable des êtres,\n>\n> Vous n’en eûtes jamais un atome, et de lettres\n>\n> Vous n’avez que les trois qui forment le mot : sot !\n>\n> Eussiez-vous eu, d’ailleurs, l’invention qu’il faut\n>\n> Pour pouvoir là, devant ces nobles galeries,\n>\n> me servir toutes ces folles plaisanteries,\n>\n> Que vous n’en eussiez pas articulé le quart\n>\n> De la moitié du commencement d’une, car\n>\n> Je me les sers moi-même, avec assez de verve,\n>\n> Mais je ne permets pas qu’un autre me les serve.\n\n## Listes\n\nSauter une ligne avant le début de la liste.\n\n### Liste non ordonnée\n\nPour créer une liste non ordonnée, il faut utiliser le symbole - pour chaque élément.\n\n<u>Exemple</u> :\nListes des fruits :\n\n- Pommes\n- Poires\n- Raisin\n\nEst obtenu par la syntaxe suivantes :\n\n```markdown\nListes des fruits :\n\n- Pommes\n- Poires\n- Raisin\n```\n\n___N.B : Une ligne vide doit précéder la liste et un espace est nécessaire entre le symbole - et l'élément de la liste.___\n\n#### Remarque\n\nIl est possible d'imbriquer des listes. Pour cela, un espace est nécessaire entre l'élément parent et la liste imbriquée.\n\n<u>Exemple</u> :\nListes des fruits :\n\n- Pommes\n - Golden\n - Gala\n - Pink Lady\n - ...\n- Poires\n- Raisin\n - Corinthe noir\n - Muscat d'Alexandrie\n \nEst obtenu par la syntaxe suivantes :\n\n```markdown\nListes des fruits :\n\n- Pommes\n - Golden\n - Gala\n - Pink Lady\n - ...\n- Poires\n- Raisin\n - Corinthe noir\n - Muscat d'Alexandrie\n```\n\n### Liste ordonnée\n\nPour créer une liste ordonnée, il faut énumérer chaque élément précédé de son rang, d'un point et d'un espace.\n\n<u>Exemple</u> :\nListe ordonnée :\n\n1. premier élément\n2. deuxième élément\n3. troisième élément\n\nEst obtenu par la syntaxe suivantes :\n\n```markdown\nListe ordonnée :\n\n1. premier élément\n2. deuxième élément\n3. troisième élément\n```\n\n#### Remarque 1\n\nLa valeur du rang ne doit pas nécessairement être indiqué. C'est le fait que chaque élément se suive qui constitue la liste ordonnée.\n\n<u>Exemple</u> :\nListe ordonnée :\n\n1. premier élément\n1. deuxième élément\n1. troisième élément\n\nEst obtenu par la syntaxe suivante :\n\n```markdown\nListe ordonnée :\n\n1. premier élément\n1. deuxième élément\n1. troisième élément\n```\n\n#### Remarque 2\n\nComme pour les listes non ordonnées, il est possible d'imbriquer des listes ordonnées. Pour cela, un espace est nécessaire entre l'élément parent et la liste imbriquée.\n\n<u>Exemple</u> :\nListe ordonnée imbriquée:\n\n1. premier élément\n 1. premier sous élément\n 2. deuxième sous élément\n2. deuxième élément\n3. troisième élément\n 1. premier sous élément\n\nEst obtenu par la syntaxe suivante :\n\n```markdown\nListe ordonnée imbriquée:\n\n1. premier élément\n 1. premier sous élément\n 2. deuxième sous élément\n2. deuxième élément\n3. troisième élément\n 1. premier sous élément\n```\n\n### Liste de cases à cocher\n\nPour créer une liste de cases à cocher, il faut énumérer chaque élément précédé par `[ ]` pour une case non cochée et `[x]` pour une case cochée.\n\n<u>Exemple</u> :\nLe langage Markdown a été créé par :\n\n- [x] John Gruber\n- [ ] Guido van Rossum\n- [x] Aaron Swartz\n- [ ] Bill Gates\n\nEst obtenu par la syntaxe suivante :\n```markdown\nLe langage Markdown a été créé par :\n\n- [x] John Gruber\n- [ ] Guido van Rossum\n- [x] Aaron Swartz\n- [ ] Bill Gates\n```\n\n__N.B : Le texte entre crochets doit comporter un _seul et un seul caractère_. Soit un espace pour une case non cochée, soit un x pour une case cochée.__\n"},{"metadata":{},"cell_type":"markdown","source":"## Titres\n\nLes titres sont créés avec un certain nombre de #(croisillons) avant le titre, qui correspondent au niveau de titre souhaité (de 1 à 6).\n\n<u>Exemple :</u>\n\n# un titre de premier niveau\n#### un titre de quatrième niveau\n\nEst obtenu par la syntaxe suivante :\n```\n# un titre de premier niveau\n#### un titre de quatrième niveau\n```"},{"metadata":{},"cell_type":"markdown","source":"## Tableaux\n\nUn tableau en Markdown est constitué de 3 éléments :\n\n1. une ligne d'en-tête\n1. une ligne de séparation\n1. un ensemble de lignes de corps du tableau\n\n<u>Exemple</u> :\n\n| Titre 1 | Titre 2 | Titre 3 |\n| :-- | :--: | --: |\n| Colonne | Colonne | Colonne |\n| Alignée à | Alignée au | Alignée à |\n| Gauche | Centre | Droite |\n\n\nEst obtenu par la syntaxe suivante :\n```\n| Titre 1 | Titre 2 | Titre 3 |\n| :-- | :--: | --: |\n| Colonne | Colonne | Colonne |\n| Alignée à | Alignée au | Alignée à |\n| Gauche | Centre | Droite |\n```\n\n### En-tête\n\nL'en-tête contient chaque titre de colonnes, séparés par un symbole |. Le titre sera automatiquement mis en gras.\n\n### Séparation\n\nLa ligne de séparation permet de délimiter l'en-tête du corps du tableau et de définir l'alignement du texte du contenu de la colonne.\n\n- `:--`: indique que le contenu est aligné à gauche de la colonne,\n- `:--:`: indique que le contenu est centré,\n- `--:`: indique que le contenu est aligné à droite de la colonne.\n\n### Corps\n\nChaque ligne du corps du tableau contient le contenu de chaque colonne séparé par un symbole |. La couleur du fond de chaque ligne du tableau est alternée automatiquement."},{"metadata":{},"cell_type":"markdown","source":"## Liens\n\nPour créer des liens de type url cliquable, il faut utiliser la syntaxe `[texte du lien](url_du_lien)`.\n\n<u>Exemple</u> : [Site du lycée Charlotte Perriand](https://charlotteperriand.etab.ac-lille.fr)\n\nEst obtenu par la syntaxe :\n```\n[Site du lycée Charlotte Perriand](https://charlotteperriand.etab.ac-lille.fr)\n```\n__N.B : il n'y a pas d'espace entre le crochet fermant et la parenthèse ouvrante. Il faut écrire ..lien](url.. et non ..lien] (url.. )__"},{"metadata":{},"cell_type":"markdown","source":"## Images\n\nPour afficher une image, il faut utiliser la syntaxe ``\n\n<u>Exemple</u> : \n\nEst obtenu par la syntaxe :\n```\n\n```\n__N.B : il n'y a pas d'espace entre le crochet fermant et la parenthèse ouvrante. Il faut écrire ..lien](url.. et non ..lien] (url.. )__"}],"metadata":{"kernelspec":{"display_name":"Python 3 (ipykernel)","language":"python","name":"python3"}},"nbformat":4,"nbformat_minor":2} |