Documentació

Introducció

Us donem la benvinguda al ghostwriter! Aquesta guia de referència ràpida dona exemples d'escriptura en Markdown, un format de marcatge de text creat per John Gruber. Per a més informació, visiteu el lloc web de John Gruber a http://www.daringfireball.net.

El ghostwriter té suport integrat per al processador «cmark-gfm». No obstant això, també pot detectar automàticament els processadors Pandoc, MultiMarkdown o «cmark». Senzillament, instal·leu qualsevol d'aquests processadors i assegureu-vos que les seves ubicacions d'instal·lació s'afegeixin a la variable d'entorn PATH del sistema. El ghostwriter detectarà automàticament la seva instal·lació en iniciar, i us donarà una vista prèvia HTML en directe i opcions d'exportació en conseqüència.

Capçaleres

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

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

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

Paràgrafs

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

This is a new paragraph.

Format en línia

Podeu fer lletra cursiva o fins i tot negreta de dues maneres. La primera és delimitant el text amb asteriscs (*), mentre que la segona és amb guions baixos (_).

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

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

També podeu fer lletra cursiva negreta mesclant i aparellant, així:

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

Enllaços

Podeu enllaçar a diversos llocs web:

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

També podeu utilitzar enllaços de referència:

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

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

Imatges

Podeu incrustar imatges així:

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

També podeu utilitzar la mateixa sintaxi que amb enllaços de referència:

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

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

Llistes

Podeu utilitzar llistes ordenades:

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

O podeu utilitzar llistes no ordenades:

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

Podeu mesclar i fer coincidir amb llistes imbricades:

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

Blocs de codi

Podeu fer el sagnat amb quatre o més espais o amb un caràcter de tabulació per a crear un bloc de codi:

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.

En alguns convertidors del Markdown, com el Pandoc o el GitHub, podeu utilitzar els accents greus de la variant GitHub del Markdown per a delimitar els blocs de codi en lloc de fer el sagnat del bloc, així:

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

L'anterior també es mostrarà com un bloc de codi preformatat.

Seccions de codi

Podeu utilitzar accents greus al mig d'un paràgraf per a delimitar el codi, com amb aquesta etiqueta `<html>`. Podeu utilitzar accents greus literals utilitzant més d'un accent greu, com ara amb aquest exemple: `` `accent greu escapat` ``.

Cites de bloc

Podeu utilitzar claus angulars a l'estil del correu electrònic per a delimitar les cites de blocs, de la manera següent:

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

Regles horitzontals

Utilitzeu tres o més guions (-), guions baixos (_), o asteriscs (*) per a les regles horitzontals, així:

---

***
___

Fins i tot podeu tenir espais entre cada caràcter:

- - -

Ampliacions del Markdown

Alguns processadors Markdown afegeixen sintaxi per a taules, notes al peu, i similars per a ampliar l'especificació original del Markdown de John Gruber. A continuació es mostra un exemple d'ús de notes al peu per al Pandoc, MultiMarkdown i altres processadors que admeten l'ampliació:

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

[^footnoteid]:  Here is the footnote text.

A continuació hi ha una taula Pandoc d'exemple:

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

Table:  Pandoc sample table.

A continuació hi ha taula «cmark-gfm» o MultiMarkdown d'exemple:

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

Hi ha encara més sintaxis de taules que aquests processadors Markdown poden acceptar. També hi ha moltes més ampliacions. Per a més informació sobre aquests processadors, visiteu els llocs web següents:

L'especificació original del Markdown de John Gruber es pot trobar a http://daringfireball.net/projects/markdown/.

Dreceres

El ghostwriter admet les dreceres següents per a editar el Markdown:

Ctrl+B
Aplica el format en negreta (intens).
Ctrl+I
Aplica el format cursiu (èmfasi).
Ctrl+K
Aplica el format barrat.
Ctrl+/
Insereix un comentari HTML a la posició del cursor si no hi ha text seleccionat, o en cas contrari convertirà el text seleccionat en un comentari HTML.
Tab
Sagna les línies de text seleccionades.
Maj+Tab
Sagna les línies de text seleccionades.
Maj+Retorn
Insereix un salt de línia d'estil Markdown.
Ctrl+Retorn
Insereix un salt de línia com de costum, excepte que el sagnat actual no es complirà. En altres paraules, si esteu escrivint sobre una línia amb sagnat i premeu Ctrl+Retorn, no s'afegirà cap sagnat a la línia nova. Tingueu en compte que el modificador Ctrl es pot combinar amb el modificador Maj per a produir una línia sense sagnat i un salt de línia d'estil Markdown.
Ctrl+.
Converteix la línia actual o les línies seleccionades en una cita de bloc.
Ctrl+,
Elimina qualsevol format de cita de bloc de la línia actual o de les línies de text seleccionades.
Ctrl+8
Converteix la línia actual o les línies seleccionades en una llista de pics amb el marcador *. Per exemple, si heu seleccionat text dins de les línies següents:
  List item one.
  List item two.

En prémer aquesta drecera les línies seleccionades es convertiran en una llista de pics com:

  * List item one.
  * List item two.
Ctrl+Maj+-
Converteix la línia actual o les línies seleccionades en una llista de pics amb el marcador -. Per exemple, si heu seleccionat text dins de les línies següents:
  List item one.
  List item two.

En prémer aquesta drecera les línies seleccionades es convertiran en una llista de pics com:

  - List item one.
  - List item two.
Ctrl+Maj+=
En prémer Ctrl i Maj amb el caràcter = es converteix la línia actual o les línies seleccionades en una llista de pics amb el marcador +. Per exemple, si heu seleccionat text dins de les línies següents:
  List item one.
  List item two.

En prémer aquesta drecera les línies seleccionades es convertiran en una llista de pics com:

  + List item one.
  + List item two.
Ctrl+1
Converteix la línia actual o les línies seleccionades en una llista numerada amb el marcador .. Per exemple, si heu seleccionat text dins de les línies següents:
  List item one.
  List item two.

En prémer aquesta drecera les línies seleccionades es convertiran en una llista numerada com:

  1. List item one.
  2. List item two.
Ctrl+0
Converteix la línia actual o les línies seleccionades en una llista numerada amb el marcador ). Per exemple, si heu seleccionat text dins de les línies següents:
  List item one.
  List item two.

En prémer aquesta drecera les línies seleccionades es convertiran en una llista numerada com:

  1) List item one.
  2) List item two.
Ctrl+T
Converteix la línia actual o les línies seleccionades en un element de la llista de tasques de la variant GitHub del Markdown. Per exemple, si heu seleccionat text dins de les línies següents:
  Important thing to do.
  Another important thing to do.

En prémer aquesta drecera les línies seleccionades es convertiran en una llista de tasques com:

  - [ ] Important thing to do.
  - [ ] Another important thing to do.
Ctrl+D
Quan la línia de text actual és un element de la llista de tasques de la variant GitHub del Markdown, en prémer aquesta tecla de drecera es canviarà l'estat de compleció de la tasca, es col·locarà una x a la casella de selecció si la tasca està completada, o s'eliminarà la x si està incompleta. Per exemple:
  - [ ] This is an incomplete task.
  - [x] This task as done!
Caràcters coincidents
Quan se selecciona un text dins d'una sola línia, en prémer qualsevol dels caràcters anteriors es tancarà el text seleccionat amb aquest caràcter i el seu caràcter de tancament coincident. Per exemple, si seleccioneu la paraula gos i després introduïu el caràcter (, la paraula gos es tancarà entre parèntesis i es convertirà en (gos). A continuació hi ha una taula que mostra el caràcter teclejat i el caràcter de tancament coincident:

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

Per a activar la concordança automàtica de caràcters mentre escriviu, marqueu «Coincideix automàticament els caràcters mentre escriviu» a la pestanya Editor del diàleg Preferències, disponible a la barra de menús a l'opció `Configuració->Preferències...`. També podeu personalitzar quins caràcters coincideixen seleccionant el botó «Personalitza els caràcters coincidents...».
Arrossegar i deixar anar fitxers d'imatges
Una alternativa a seleccionar l'opció Edita -> Insereix una imatge... des de la barra de menús és arrossegar i deixar anar qualsevol fitxer d'imatge des del sistema de fitxers a la finestra de l'editor. L'aplicació inserirà un text d'imatge en línia amb el camí del fitxer de la imatge relatiu a la ubicació del document obert actualment, o el camí complet si el document no té títol. Per exemple:

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

o si el document no té títol:

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