La syntaxe Markdown et NotePad++

Le Markdown est un langage de balisage dont la saisie en mode texte permet très facilement d’écrire, de lire et d’exporter un document dans différent format (PDF, HTML…). A ce jour, c’est l’un des principaux  format d’écriture du Net.

Il existe de nombreux outils pour écrire des documents dans ce format, mais je vais vous parler ici principalement de NotePad++. Pour trouver d’autres éditeurs libres Markdown, vous pouvez vous référer à cette liste : https://framalibre.org/tags/markdown

Cette syntaxe peut être utilisée dans de nombreux cas, comme la prise de notes, la rédaction d’article Wiki ou pour le Web. Personnellement, je l’utilise pour la gestion de projet car très portable et non dépendant d’un outil logiciel auquel on n’a pas toujours accès au moment où en a besoin !

Voici les principales balises Markdown que j’utilise avec leur rendues au format HTML.

Markdown et Notepad++

Markdown et Notepad++

En résumé, les principales balises Markdown

Titres et en-têtes # H12, ## H, ### H3
Italique *text*
Gras **text**
Souligné _text_
Liste numérotée 1. step1
1. step2
Liste à puces * item1
* item2
Checklist – [ ] item1
– [ ] item2
Lien http://example.com/path
[This link](http://example.com/path)Couleur{color: red| text}

Les titres

En Markdown, 6 niveaux de titres sont disponibles. Plusieurs méthodes sont possibles.
Pour la première, il faut précéder le titre avec un dièse (#).

# Titre de niveau 1 (\# \#\# \#\#\# etc.)

## Titre de niveau 2
### Titre de niveau 3
#### Titre de niveau 4
##### Titre de niveau 5
###### Titre de niveau 6

Résultat pour les titres :

Titre de niveau 1 (# ## ### etc.)

Titre de niveau 2

Titre de niveau 3

Titre de niveau 4

Titre de niveau 5
Titre de niveau 6

L’autre méthode ne permet de faire que 2 niveaux :

Titre de niveau 1 (nécessite 4 = )
====

Titre de niveau 2 (nécessite 4 -)
----

Titre de niveau 1 (nécessite 4 = )

Titre de niveau 2 (nécessite 4 -)

Le gras et caractère italique

Texte normal **en gras** ou __gras__ et *en italique* ou _italique_ .

Texte normal en gras ou gras et en italic ou italic .

Les listes

Il est possible de faire des listes à puces ordonnées ou non.

Liste à Puce

- Liste à puces ( *, - ou + )
- 2e puce
* Autre liste à puce
* Sous niveau
  • Liste à puces ( *, – ou + )
  • 2e puce
  • Autre liste à puce
    • Sous niveau

Les listes numérotées (ordonnées)

1. Liste ordonnée - numéro 1
2. numéro 2
  1. Liste ordonnée – numéro 1
  2. numéro 2

Il est possible de préciser le numéro de départ :

57. On commence au numéro 57
1. On continue
  1. On commence au numéro 57
  2. On continue

Liste en mode case à cocher

- [ ] Case non cochée
- [x] Case cochée
  • Case non cochée
  • Case cochée

Les citations (blockquote)

Pour les citations, il faut précéder les lignes d’un chevron « > » :

> blockquote

> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.

blockquote

Blockquotes can also be nested…

…by using additional greater-than signs right next to each other…

…or with spaces between arrows.

L’affichage de code

Pour insérer un code, il suffit de l’entourer d’accents graves « \` » :

  • Code source en ligne :
* code:
`a === a`

code: a === a

  • Code avec mise en forme suivant le langage avec \« ` ou \~~~

« `xml
<lifeCycle>
<retentionType>IDENTITE</retentionType>
<referencyDate>2013-04-30</referencyDate>
</lifeCycle>
« `

<lifeCycle> 
		<retentionType>IDENTITE</retentionType> 
		<referencyDate>2013-04-30</referencyDate> 
	</lifeCycle>

 

~~~
<test>
XXX
</test>
~~~

	<test>
	XXX
	</test>

« `sql
SELECT A.CLIENT, A.ID_APP, A.NOM, A.PRENOM
FROM REFERENTIEL.ADRESSE A
FULL JOIN REFERENTIEL.CLIENT B
ON A.CLIENT = B.CLIENT
FULL JOIN REFERENTIEL.ORGANISATION C
ON A.CLIENT = C.CLIENT
WHERE ID_APP IN (‘999999′,’888888′,’777777’)
« `

	SELECT A.CLIENT, A.ID_APP, A.NOM, A.PRENOM
FROM REFERENTIEL.ADRESSE A
FULL JOIN REFERENTIEL.CLIENT B
ON A.CLIENT = B.CLIENT
FULL JOIN REFERENTIEL.ORGANISATION C
ON A.CLIENT = C.CLIENT
WHERE ID_APP IN ('999999','888888','777777')
  • Autres langages :
    • java
    • js (‘*.js’)
    • jsp (‘*.jsp’)
    • bat (‘.bat’, ‘.cmd’)

Les liens – URL

[Texte du lien](http://www.google.fr "Texte pour le titre, facultatif")
URL: [MSI.nc][2] | image: ![3][]
- Egalement sous la forme [MSI.nc](https://www.msi.nc).

[2]: https://www.msi.nc
[3]: https://www.msi.nc/wp-content/uploads/actumsi2.png

Texte du lien

URL: MSI.nc | image: 3

  • Egalement sous la forme MSI.nc.

Les tables et tableaux

Insérer un tableau

Pour insérer un tableau, utiliser trois tiret ou plus (—) pour créer chaque en-tête de colonne, et utiliser les pipes (|) pour séparer chaque colonne.

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Syntax Description
Header Title
Paragraph Text

Alignement du contenu des colonnes

Il est possible d’aligner le texte dans une colonne à gauche, droiite ou au centre en ajoutant « : » à gauche, à droite ou des deux côtés des traits d’union (tiret) dans la ligne d’en-tête.

| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
Syntax Description Test Text
Header Title Here’s this
Paragraph Text And more

Voici un générateur de tableau pour Markdown Générateur de tableau.

Autres possibilité

Escape

Escape \* \` \< \_ \# \\ & more.

Les émoticônes

Balisage classique: :wink: :cry: :idea: :arrow: :neutral: :roll:

Les raccourcis émoticônes : :-) :-( 8-) ;) :-D :-o :lol: :-P ;-) :!: :?:

Balisage classique: 😉 😥 💡 ➡ 😐 🙄

Les raccourcis émoticônes : 🙂 🙁 😎 😉 😀 😮 😆 😛 😉 ❗ ❓

Indice et exposant

- 19^th^
- H~2~O
  • 19th
  • H2O

Souligner, rayer, surligner

++Texte souligné++
~~Texte barré.~~
==Texte surligné==

Texte souligné Texte barré. Texte surligné

Notes de pied de page

Note 1 avec le lien[^first].

Note 2 avec le lien[^second].

On peut faire appel à la référence une nouvelle fois[^second].

[^first]: Note de pied de page **avec balisage**

et plusieurs paragraphes.

[^second]: Texte note de pied de page.

Note 1 avec le lien1.

Note 2 avec le lien2.

On peut faire appel à la référence une nouvelle fois2.

Définition 2b

Les liens pour utiliser le langage Markdown et Notepad++

La syntaxe Markdown : https://www.markdownguide.org/basic-syntax/

Notepad++ : https://notepad-plus-plus.org/

Les extensions Markdown Notepad++ : https://github.com/nea/MarkdownViewerPlusPlus et https://github.com/mohzy83/NppMarkdownPanel

Mise en forme de la syntaxe Markdown dans Notepad++ : https://github.com/Edditoria/markdown-plus-plus

Générateur de tableau pour Markdown : https://www.tablesgenerator.com/markdown_tables

Un plugin Markdown pour Word : http://www.writage.com/


  1. Note de pied de page avec balisage et plusieurs paragraphes.
  2. Texte note de pied de page.

Vous avez aimé cet article ? Alors, partagez-le avec vos relations en cliquant sur les boutons ci-dessous :

 

Leave A Comment?

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.