Documentatie

Inleiding

Welkom bij ghostwriter! Deze snelle referentiegids geeft voorbeelden van het schrijven in Markdown, een opmaakformaat van platte tekst gemaakt door John Gruber. Voor meer informatie, bezoek de website van John Gruber op http://www.daringfireball.net.

ghostwriter heeft ingebouwde ondersteuning voor de cmark-gfm processor. Het kan echter ook automatisch Pandoc, MultiMarkdown of cmark processors detecteren. Installeer eenvoudig deze processors en ga na dat hun installatielocaties in de omgevingsvariabele PATH staan of toegevoegd. ghostwriter zal hun installatie automatisch detecteren bij opstarten en u bijpassend een live HTML-vooruitblik en exportopties bieden.

Hoofdstuktitels

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

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

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

Alinea's

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

This is a new paragraph.

Inline opmaken

U kunt cursief of zelfs vet doen op twee manieren. De eerste is door de tekst te omgeven met sterren (*), terwijl de tweede is met underscores (_).

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

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

U kunt ook vet cursief door mengen en overeen laten komen, met:

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

Koppelingen

U kunt koppelen naar verschillende websites:

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

U kunt ook referentiekoppelingen gebruiken:

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

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

Afbeeldingen

U kunt afbeeldingen inbedden met:

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

U kunt ook dezelfde syntaxis gebruiken als met referentiekoppelingen:

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

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

Lijsten

U kunt geordende lijsten gebruiken:

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

Of ongeordende lijsten gebruiken:

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

U kunt mengen en overeen laten komen met geneste lijsten:

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

Codeblokken

U kunt inspringen met vier of meer spaties of een tab-teken om een codeblok aan te maken:

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.

In sommige Markdown converters, zoals Pandoc of GitHub, kunt u backticks uit GitHub-Flavored Markdown gebruiken om codeblokken te omgeven in plaats van het blok te laten inspringen, met:

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

Het bovenstaande zal evenzo getoond worden als een vooraf geformatteerd blok code.

Code omgeven

U kunt backticks in het midden van een paragraaf gebruiken om code te omgeven, zoals met deze tag `<html>`. U kunt letterlijke backticks gebruiken door meer dan één backtick te gebruiken, zoals im dit voorbeeld: `` `escaped backtick` ``.

Blokquotes

U kunt hoekhaakjes in e-mail-stijl gebruiken om blokquotes te omgeven, met:

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

Horizontale lijnen

Drie of meer streepjes (-), underscores (_) of sterren (*) gebruiken voor horizontale lijnen, met:

---

***
___

U kunt zelfs spaties tussen elk teken hebben:

- - -

Uitbreidingen van Markdown

Sommige Markdown processors voegen syntaxis toe voor tabellen, voetnoten enzovoort om de originele Markdown-specificatie van John Gruber uit te breiden. Onderstaand is een voorbeeld van het gebruik van een voetnoot voor Pandoc, MultiMarkdown en andere processors die de uitbreiding ondersteunen:

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

[^footnoteid]:  Here is the footnote text.

Onderstaand is een voorbeeld tabel van Pandoc:

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

Table:  Pandoc sample table.

Onderstaand is een voorbeeld tabel van cmark-gfm of MultiMarkdown:

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

Er is zelfs nog meer tabelsyntaxis die deze Markdown processors kan ondersteunen. Er zijn ook veel meer uitbreidingen. Voor meer informatie over deze processors, bezoek de volgende websites:

De originele Markdown-specificatie van John Gruber is te vinden op http://daringfireball.net/projects/markdown/.

Sneltoetsen

ghostwriter ondersteunt de volgende sneltoetsen voor bewerking van Markdown:

Ctrl+B
Past vet (strong) formattering toe.
Ctrl+I
Past cursief (emphasis) formattering toe.
Ctrl+K
Past doorstrepen formattering toe.
Ctrl+/
Voegt een HTML commentaar toe op de positie van de cursor als geen tekst is geselecteerd of zal anders de geselecteerde tekst veranderen in een HTML commentaar.
Tab
Laat de geselecteerde regels tekst inspringen.
Shift+Tab
Haalt in de geselecteerde regels tekst inspringen weg.
Shift+Enter
Voegt een regelafbreking in in de stijl van Markdown.
Ctrl+Enter
Voegt een regelafbreking in zoals gebruikelijk, behalve dat de huidige inspringing niet verder gaat. Met andere woorden, als u typt op een ingesprongen regel en op Ctrl+Enter drukt, zal er geen inspringen toegevoegd worden aan de nieuwe regel. Merk op dat de Ctrl-modifier gecombineerd kan worden met de Shift-modifier om beiden te produceren een niet ingesprongen regel en een regelafbreking in de stijl van Markdown.
Ctrl+.
Maakt van de huidige regel of de geselecteerde regels een blokquote.
Ctrl+,
Verwijdert formattering van blokquote uit de huidige regel of de geselecteerde regels tekst.
Ctrl+8
Maakt van de huidige regel of de geselecteerde regels een lijst met stippen met de markering *. Bijvoorbeeld, als u tekst hebt geselecteerd in de volgende regels:
  List item one.
  List item two.

Op deze sneltoets drukken zal de geselecteerde regels omzetten in een lijst met stippen zoals:

  * List item one.
  * List item two.
Ctrl+Shift+-
Maakt van de huidige regel of de geselecteerde regels een lijst met stippen met de markering -. Bijvoorbeeld, als u tekst hebt geselecteerd in de volgende regels:
  List item one.
  List item two.

Op deze sneltoets drukken zal de geselecteerde regels omzetten in een lijst met stippen zoals:

  - List item one.
  - List item two.
Ctrl+Shift+=
Indrukken van Ctrl en Shift met het teken = maakt van de huidige regel of de geselecteerde regels een lijst met stippen met de markering +. Bijvoorbeeld, als u tekst hebt geselecteerd in de volgende regels:
  List item one.
  List item two.

Op deze sneltoets drukken zal de geselecteerde regels omzetten in een lijst met stippen zoals:

  + List item one.
  + List item two.
Ctrl+1
Maakt van de huidige regel of de geselecteerde regels een genummerde lijst met de markering .. Bijvoorbeeld, als u tekst hebt geselecteerd in de volgende regels:
  List item one.
  List item two.

Op deze sneltoets drukken zal de geselecteerde regels omzetten in een genummerde lijst zoals:

  1. List item one.
  2. List item two.
Ctrl+0
Maakt van de huidige regel of de geselecteerde regels een genummerde lijst met de markering .. Bijvoorbeeld, als u tekst hebt geselecteerd in de volgende regels:
  List item one.
  List item two.

Op deze sneltoets drukken zal de geselecteerde regels omzetten in een genummerde lijst zoals:

  1) List item one.
  2) List item two.
Ctrl+T
Maakt van de huidige regel of de geselecteerde regels een takenlijstitem met GitHub-Flavored Markdown. Bijvoorbeeld, als u tekst hebt geselecteerd in de volgende regels:
  Important thing to do.
  Another important thing to do.

Op deze sneltoets drukken zal de geselecteerde regels omzetten in een takenlijst zoals:

  - [ ] Important thing to do.
  - [ ] Another important thing to do.
Ctrl+D
Wanneer de huidige regel tekst een takenlijstitem is met GitHub-Flavored Markdown, dan schakelt deze sneltoets de voltooidstatus van de taak om, door een x in het keuzevak te plaatsen als de taak voltooid is of de x te verwijderen als deze niet voltooid is. Bijvoorbeeld:
  - [ ] This is an incomplete task.
  - [x] This task as done!
Overeenkomende tekens
Wanneer tekst in een enkele regel is geselecteerd en een van de bovenstaande tekens wordt ingedrukt, dan zal de geselecteerde tekst met dat teken en zijn overeenkomende sluitteken worden omgeven. Bijvoorbeeld, als u het woord hond selecteert en dan het teken ( invoert, dan zal het woord hond omgeven worden met de haakjes en (hond) worden. Onderstaand is een tabel die de ingetypte tekens toont en het overeenkomende sluitteken:

OpenenWordt gesloten
""
''
()
[]
{}
**
__
``
<>

Om automatisch overeenkomende tekens in te schakelen als u typt, activeer "Automatisch tekens overeen laten komen tijdens typen" uit het tabblad Bewerken in de dialoog voorkeuren, beschikbaar in de menubalk onder de optie `Instellingen->Voorkeuren...`. U kunt ook aanpassen welke tekens overeenkomen door de knop "Overeenkomende tekens aanpassen..." te selecteren.
Afbeeldingsbestanden slepen en loslaten
Een alternatief voor selecteren van de optie Bewerken->Afbeelding invoegen... uit de menubalk is het slepen en loslaten van een afbeeldingsbestand uit uw bestandssysteem in het bewerkingsvenster. De toepassing zal inline afbeeldingstekst invoegen met het bestandspad van uw afbeelding relatief tot de huidige geopende locatie van het document of het volledige pad als het document geen titel heeft. Bijvoorbeeld:

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

of als het document geen titel heeft:

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