Documentation

Introduction

Bienvenu dans Ghostwriter ! Ce guide de référence rapide donne des exemples d'écriture avec le langage Markdown, un format de balisage de texte brut créé par John Gruber. Pour plus d'informations, veuillez visiter le site Internet de John Gruber à l'adresse http://www.daringfireball.net.

Ghostwriter intègre une prise en charge pour le processeur « cmark-gfm ». Cependant, il peut également détecter automatiquement les processeurs « Pandoc », « multi-Markdown » ou « cmark ». Veuillez simplement installer l'un de ces processeurs et vous assurer que leurs emplacements d'installation sont ajoutés à la variable d'environnement « PATH » de votre système. Ghostwriter détectera automatiquement leur installation au démarrage et vous donnera en conséquence accès à des options de prévisualisation et d'exportation « HTML » en direct .

En-têtes

# Level 1 Heading
## Level 2 Heading ##
###### Level 6 Heading

Level 1 Heading
===============
some text

Level 2 Heading
---------------
some more text

Paragraphes

This is a paragraph.
This is another line in the same paragraph using a manual line break.

This is a new paragraph.

Formatage en ligne

Vous pouvez réaliser Italique ou même Gras de deux manières. La première consiste à entourer le texte avec des astérisques (*), tandis que la seconde avec des soulignements (_).

This is *italics* with asterisks.
This is _italics_ with underscores.

This is **bold** with asterisks.
This is __bold__ with underscores.

Vous pouvez également utiliser Gras Italique en mélangeant et en faisant correspondre ainsi :

This is ***bold italics*** with asterisks.
This is **_bold italics_** mixing.
This is another *__bold italics__*.
etc.

Liens

Vous pouvez créer un lien vers divers sites Internet :

Click [here](http://url.com "Title") to visit a website.

Vous pouvez également utiliser des liens de référence :

[This][id] is a reference link which is defined below.

[id]: http://url.com "Title"

Images

Vous pouvez intégrer des images comme cela :

![alternate text](./image.jpg "Title")

Vous pouvez également utiliser la même syntaxe comme celles des liens de référence :

![alternate text][id] for a reference defined below.

[id]: ./image.jpg "Title"

Listes

Vous pouvez utiliser les listes ordonnées :

1. Item one.
2. Item two.
3. Item three.

Ou vous pouvez utiliser des listes non triées :

* Item one.
+ Item two.
- Item three.

Vous pouvez mélanger et faire correspondre avec des listes imbriquées :

1. Item one.
    * Subitem one.
    * Subitem two.
2. Item two.
    - Subitem one.
    - Subitem two.
3. Item three.
    1. Subitem three.

Blocs de code

Vous pouvez indenter avec quatre espaces ou plus ou un caractère de tabulation pour créer un bloc de code :

This is a normal paragraph, followed by a code block.
    
    for (int i = 0; i < 10; i++) {
        System.out.println("i = " + i);
    }
    
The above will be displayed as a preformatted block of code.

Dans certains convertisseurs pour le langage « Markdown », tels que « Pandoc » ou « GitHub », vous pouvez utiliser les accents graves de « GitHub Markdown » pour délimiter les blocs de code au lieu d'indenter le bloc, comme ceci :

```
for (int i = 0; i < 10; i++) {
    System.out.println("i = " + i);
}
```

Ce qui précède sera également affiché sous forme de bloc de code préformaté.

Portées du code

Vous pouvez utiliser des caractères d'accent grave au milieu d'un paragraphe pour délimiter le code, comme avec cette balise «  ». Vous pouvez utiliser des caractères d'accent grave multiples en utilisant plus d'un caractère d'accent grave, comme avec cet exemple: ESC accent grave `` `.

Blocs de citations

Vous pouvez utiliser des parenthèses de style courriel pour délimiter les citations de blocs, comme suit :

> This is a block quote.
>
>> This is a nested block quote.

Règles horizontales

Utilisez trois tirets ou plus (\ -), un caractère de soulignement (_) ou des astérisques (*) pour les règles horizontales, comme ceci :

---

***
___

Vous pouvez même avoir des espaces entre chaque caractère :

- - -

Extensions pour le langage Markdown

Certains processeurs « Markdown » ajoutent une syntaxe pour les tables, les notes de bas de page, etc. pour étendre la spécification « Markdown » d'origine de John Gruber. Vous trouverez ci-dessous un exemple d'utilisation pour une note de bas de page pour « Pandoc », « Multi-Markdown » et autres processeurs prenant en charge l'extension :

Here is the body text that has a footnote.[^footnoteid]

[^footnoteid]:  Here is the footnote text.

Vous trouverez ci-dessous un exemple de table « Pandoc » :

Column One     Column Two
----------     ----------
Row Text 1     Row Text 2
Row Text 1     Row Text 2

Table:  Pandoc sample table.

Vous trouverez ci-dessous un exemple de table « cmark-gfm » ou « MultiMarkdown » :

Column One | Column Two
---------- | ----------
Row Text 1 | Row Text 2
Row Text 1 | Row Text 2

Il y a encore plus de syntaxes de table que ces processeurs « Markdown » peuvent prendre en charge. Il y a aussi beaucoup plus d'extensions. Pour plus d'informations sur ces processeurs, veuillez visiter les sites Internet suivants :

• Pandoc : http://johnmacfarlane.net/pandoc/
• Multi Markdown : http://fletcherpenney.net/multimarkdown/
• cmark : http://github.com/jgm/cmark/
• cmark-gfm : http://github.com/github/cmark

La spécification d'origine de Markdown de John Gruber peut être trouvée à la page http://daringfireball.net/projects/markdown/.

Raccourcis

• Ghostwriter * prend en charge les raccourcis suivants pour l'édition Markdown :

CTRL + B

Applique un formatage en texte gras (fort).

CTRL + I

Applique le formatage en texte italique (accentué).

CTRL + K

Applique un formatage en texte barré.

CTRL + /

Insère un commentaire « HTML » à la position de curseur si aucun texte n'est sélectionné ou bien, transformera le texte sélectionné en un commentaire « HTML ».

Tab

Indente les lignes de texte sélectionnées.

Maj + Tab

Enlève l'indentation des lignes de texte sélectionnées.

Maj + Entrée

Insère un saut de ligne de style Markdown.

CTRL + Entrée

Insère un saut de ligne comme d'habitude, sauf que l'indentation courante ne sera pas respectée. En d'autres termes, si vous faites une saisie sur une ligne indentée et que vous appuyez sur le raccourci « CTRL » + « Entrée », aucune indentation ne sera ajoutée à la nouvelle ligne. Veuillez noter que le modificateur « CTRL » peut être combiné avec le modificateur « Maj » pour produire à la fois une ligne non indentée et un retour à la ligne de style « Markdown ».

CTRL + .

Transforme la ligne actuelle ou les lignes sélectionnées en un bloc de citations.

CTRL + ,

Supprime n'importe quel formatage de citation de blocs à partir de la ligne actuelle ou des lignes de texte sélectionnées.

CTRL + 8

Transforme la ligne actuelle ou les lignes sélectionnées en une liste à puces avec le marqueur « * ». Par exemple, si vous avez sélectionné du texte dans les lignes suivantes :

  List item one.
  List item two.

Un appui sur cette touche de raccourci transformera les lignes sélectionnées en une liste à puces comme ceci :

  * List item one.
  * List item two.

CTRL + Maj + -

Transforme la ligne actuelle ou les lignes sélectionnées en une liste à puces avec le marqueur « - ». Par exemple, si vous avez sélectionné du texte dans les lignes suivantes :

  List item one.
  List item two.

Un appui sur cette touche de raccourci transformera les lignes sélectionnées en une liste à puces comme ceci :

  - List item one.
  - List item two.

CTRL + Maj + =

Veuillez appuyer sur « CTRL » et « Maj » avec le caractère « = » transforme la ligne courante ou les lignes sélectionnées en une liste à puces avec le caractère « + ». Par exemple, si vous avez sélectionné du texte dans les lignes suivantes :

  List item one.
  List item two.

Un appui sur cette touche de raccourci transformera les lignes sélectionnées en une liste à puces comme ceci :

  + List item one.
  + List item two.

CTRL + 1

Transforme la ligne courante ou les lignes sélectionnées en une liste numérotée avec le marqueur « . ». Par exemple, si vous avez sélectionné du texte dans les lignes suivantes :

  List item one.
  List item two.

Un appui sur cette touche de raccourci transformera les lignes sélectionnées en une liste numérotée comme ceci :

  1. List item one.
  2. List item two.

CTRL + 0

Transforme la ligne courante ou les lignes sélectionnées en une liste numérotée avec le marqueur « ) ». Par exemple, si vous avez sélectionné du texte dans les lignes suivantes :

  List item one.
  List item two.

Un appui sur cette touche de raccourci transformera les lignes sélectionnées en une liste numérotée comme ceci :

  1) List item one.
  2) List item two.

CTRL + T

Transforme la ligne courante ou les lignes sélectionnées en un élément de liste de tâches « Markdown » dans le style« GitHub ». Par exemple, si vous avez sélectionné du texte dans les lignes suivantes :

  Important thing to do.
  Another important thing to do.

Un appui sur cette touche de raccourci transformera les lignes sélectionnées en une liste de tâches comme ceci :

  - [ ] Important thing to do.
  - [ ] Another important thing to do.

CTRL + D

Lorsque la ligne de texte courante est un élément de liste de tâches de style « GitHub », un appui sur ce raccourci fera basculer l'état de complètement de la tâche, en plaçant un « x » dans la case à cocher si la tâche est terminée ou le supprimant si la tâche est incomplète. Par exemple :

  - [ ] This is an incomplete task.
  - [x] This task as done!

Caractères correspondants

Lorsque le texte dans une seule ligne est sélectionné, un appui sur l'un des caractères ci-dessus enfermera le texte sélectionné avec ce caractère et son caractère de clôture correspondant. Par exemple, si vous sélectionnez le mot « chien », puis saisissez dans le caractère « ( », alors, le mot « chien » sera enfermé entre parenthèses et deviendra « (chien) ». Vous trouvez ci-dessous un tableau affichant le caractère saisi et le caractère correspondant de fermeture :

Ouverture	En fermeture
"	"
'	'
(	)
[	]
{	}
*	*
_	_
`	`
<	>

Pour activer la correspondance automatique de caractères au fur et à mesure que vous saisissez, veuillez cocher « Faire correspondre automatiquement les caractères tout en saisissant » de l'onglet « Éditeur » dans la boîte de dialogue « Préférences », disponible à partir de la barre de menu sous l'option « Configuration / Préférences ... ». Vous pouvez également personnaliser les caractères correspondants en sélectionnant le bouton « Personnaliser les caractères correspondants ... ».

Glisser et déposer de fichiers d'images

Une alternative à l'option de sélection « Édition / Insérer une image... » dans la barre de menus est de faire un glisser et déposer de n'importe quel fichier d'image de votre système de fichiers dans la fenêtre de l'éditeur. L'application insérera le texte de l'image en ligne avec l'emplacement du fichier de votre image par rapport à l'emplacement du document actuellement ouvert ou l'emplacement complet si le document est sans titre. Par exemple :

  ![](../../relative/path/to/your/file.png)

ou si le document n'a aucun titre :

  ![](file:///full/path/to/your/file.png)