Dokumentace

Úvod

Vítejte na stránkách ghostwriter! Tento stručný návod obsahuje příklady psaní v Markdownu, formátu pro značkování prostého textu, který vytvořil John Gruber. Další informace najdete na webových stránkách Johna Grubera na adrese http://www.daringfireball.net.

ghostwriter má vestavěnou podporu pro procesor cmark-gfm. Umí však také automaticky rozpoznat procesory Pandoc, MultiMarkdown nebo cmark. Stačí nainstalovat kterýkoli z těchto procesorů a zajistit, aby byly jejich instalační adresáře přidány do systémové proměnné prostředí PATH. ghostwriter jejich instalaci automaticky rozpozná při spuštění a podle toho vám nabídne živý náhled v HTML a možnosti exportu.

Nadpisy

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

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

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

Odstavce

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

This is a new paragraph.

Vložené formátování

Kurzívu nebo dokonce tučné písmo můžete vytvořit dvěma způsoby. První spočívá v obklopení textu hvězdičkami (*), zatímco druhý v podtržítkách (_).

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

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

Můžete také vytvořit tučné kurzívy kombinováním různých stylů, například takto:

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

Odkazy

Můžete zde vložit odkazy na různé webové stránky:

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

Můžete také použít odkazy na zdroje:

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

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

Obrázky

Obrázky můžete vložit takto:

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

Můžete také použít stejnou syntaxi jako u odkazů na zdroje:

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

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

Seznamy

Můžete použít seřazené seznamy:

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

Nebo můžete použít neseřazené seznamy:

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

Můžete kombinovat a libovolně sestavovat vnořené seznamy:

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

Bloky kódu

K vytvoření bloku kódu můžete použít odsazení čtyřmi nebo více mezerami nebo znakem tabulátoru:

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.

V některých konvertorech Markdownu, jako jsou Pandoc nebo GitHub, můžete k ohraničení bloků kódu použít zpětné lomítka formátu GitHub-Flavored Markdown namísto odsazení bloku, a to takto:

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

Výše uvedené se rovněž zobrazí jako předformátovaný blok kódu.

Rozsahy kódu

K vyznačení kódu můžete uprostřed odstavce použít zpětné lomítko, jako v případě této značky `<html>`. Literální zpětné lomítko můžete zadat tak, že použijete více než jedno zpětné lomítko, například v tomto příkladu: `` `escaped backtick` ``.

Blokové citace

K ohraničení blokových citací můžete použít ostré závorky, jaké se používají v e-mailech, a to následujícím způsobem:

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

Vodorovné čáry

Pro vodorovné čáry použijte tři nebo více pomlček (-), podtržítků (_) nebo hvězdiček (*), například takto:

---

***
___

Mezi jednotlivými znaky můžete dokonce nechat mezery:

- - -

Rozšíření Markdownu

Některé procesory Markdownu rozšiřují původní specifikaci Markdownu od Johna Grubera o syntaxi pro tabulky, poznámky pod čarou a podobně. Níže je uveden příklad použití poznámky pod čarou pro Pandoc, MultiMarkdown a další procesory, které toto rozšíření podporují:

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

[^footnoteid]:  Here is the footnote text.

Níže je uveden příklad tabulky vytvořené pomocí Pandocu:

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

Table:  Pandoc sample table.

Níže je uveden příklad tabulky vytvořené pomocí cmark-gfm nebo MultiMarkdown:

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

Tyto procesory Markdownu podporují ještě více syntaxí pro tabulky. Existuje také mnoho dalších rozšíření. Další informace o těchto procesorech najdete na následujících webových stránkách:

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

Původní specifikaci Markdownu od Johna Grubera najdete na adrese http://daringfireball.net/projects/markdown/.

Klávesové zkratky

ghostwriter podporuje následující klávesové zkratky pro úpravy v Markdownu:

Ctrl+B

Použije tučné (výrazné) formátování.

Ctrl+I

Použije formátování kurzívou (zdůraznění).

Ctrl+K

Použije formátování přeškrtnutím.

Ctrl+/

Pokud není vybrán žádný text, vloží HTML komentář na pozici kurzoru; v opačném případě převede vybraný text na HTML komentář.

Tab

Odsadí vybrané řádky textu.

Shift+Tab

Zruší odsazení vybraných řádků textu.

Shift+Enter

Vloží konec řádku ve stylu Markdownu.

Ctrl+Enter

Vloží konec řádku jako obvykle, s tím rozdílem, že aktuální odsazení nebude zachováno. Jinými slovy, pokud píšete na odsazeném řádku a stisknete Ctrl+Enter, na nový řádek se žádné odsazení nepřidá. Upozorňujeme, že modifikační klávesu Ctrl lze kombinovat s modifikační klávesou Shift, čímž vznikne jak neodsazený řádek, tak konec řádku ve stylu Markdownu.

Ctrl+.

Převede aktuální řádek nebo vybrané řádky na blokovou citaci.

Ctrl+,

Odstraní veškeré formátování blokové citace z aktuálního řádku nebo z vybraných řádků textu.

Ctrl+8

Převede aktuální řádek nebo vybrané řádky na seznam s odrážkami s označením *. Například pokud jste vybrali text v následujících řádcích:

  List item one.
  List item two.

Stisknutím této klávesové zkratky se vybrané řádky změní na seznam s odrážkami, a to takto:

  * List item one.
  * List item two.

Ctrl+Shift+-

Převede aktuální řádek nebo vybrané řádky na seznam s odrážkami s oddělovačem -. Například pokud jste vybrali text v následujících řádcích:

  List item one.
  List item two.

Stisknutím této klávesové zkratky se vybrané řádky změní na seznam s odrážkami, a to takto:

  - List item one.
  - List item two.

Ctrl+Shift+=

Stisknutím kláves Ctrl a Shift spolu se znakem = převedete aktuální řádek nebo vybrané řádky na seznam s odrážkami a značkou +. Například pokud jste vybrali text v následujících řádcích:

  List item one.
  List item two.

Stisknutím této klávesové zkratky se vybrané řádky změní na seznam s odrážkami, a to takto:

  + List item one.
  + List item two.

Ctrl+1

Převede aktuální řádek nebo vybrané řádky na číslovaný seznam s oddělovačem .. Například pokud jste vybrali text v následujících řádcích:

  List item one.
  List item two.

Stisknutím této klávesové zkratky se vybrané řádky změní na číslovaný seznam, a to takto:

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

Ctrl+0

Převede aktuální řádek nebo vybrané řádky na číslovaný seznam s oddělovačem ). Například pokud jste vybrali text v následujících řádcích:

  List item one.
  List item two.

Stisknutím této klávesové zkratky se vybrané řádky změní na číslovaný seznam, a to takto:

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

Ctrl+T

Převede aktuální řádek nebo vybrané řádky na položku seznamu úkolů ve formátu GitHub-Flavored Markdown. Například pokud jste vybrali text v následujících řádcích:

  Important thing to do.
  Another important thing to do.

Stisknutím této klávesové zkratky se vybrané řádky změní na seznam úkolů, a to takto:

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

Ctrl+D

Pokud je aktuální řádek textu položkou seznamu úkolů ve formátu GitHub-Flavored Markdown, stisknutím této klávesové zkratky přepnete stav splnění úkolu – do zaškrtávacího políčka se vloží znak x, pokud je úkol splněn, nebo se znak x odstraní, pokud je úkol nesplněn. Například:

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

Přiřazované znaky

Je-li vybrán text v rámci jednoho řádku, stisknutím kteréhokoli z výše uvedených znaků se vybraný text uzavře tímto znakem a jeho odpovídajícím uzavíracím znakem. Například pokud vyberete slovo dog a poté zadáte znak (, slovo dog bude uzavřeno v závorkách a změní se na (dog). Níže je tabulka, která ukazuje zadaný znak a odpovídající uzavírací znak:

Otevírání	Uzavírání
"	"
'	'
(	)
[	]
{	}
*	*
_	_
`	`
<	>

Chcete-li povolit automatické přiřazování znaků během psaní, zaškrtněte políčko "Automaticky přiřazovat znaky během psaní" na záložce Editor v dialogovém okně Předvolby, které najdete v nabídkové liště pod položkou `Nastavení->Předvolby...`. Můžete také přizpůsobit, které znaky se mají přiřazovat, a to kliknutím na tlačítko "Přizpůsobit přiřazované znaky...".

Přetažení obrázkových souborů

Alternativou k výběru možnosti Upravit->Vložit obrázek... z nabídkové lišty je přetažení libovolného obrázkového souboru z vašeho souborového systému do okna editoru. Aplikace vloží text s obrázkem přímo do textu, přičemž použije relativní cestu k souboru obrázku vztaženou k umístění aktuálně otevřeného dokumentu, nebo úplnou cestu, pokud dokument nemá název. Například:

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

nebo pokud dokument nemá název:

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