Документація

Вступ

Ласкаво просимо до ghostwriter! У цьому короткому довідковому підручнику наведено приклади написання тексту у Markdown, форматі розмітки звичайного тексту, який створено Джоном Ґрубером (John Gruber). Щоб дізнатися більше, будь ласка, відвідайте сайт Джона Ґрубера за адресою http://www.daringfireball.net.

У ghostwriter передбачено вбудовану підтримку обробника cmark-gfm. Втім, програма також може автоматично виявляти обробники Pandoc, MultiMarkdown та cmark. Просто встановіть один із цих обробників і переконайтеся, що каталоги, до яких ви їх встановили, додано до змінної середовища PATH вашої системи. ghostwriter автоматично виявить встановлені обробники під час запуску і показуватиме вам інтерактивний перегляд HTML та параметри експортування відповідно до знайденого обробника.

Заголовки

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

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

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

Абзаци

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

This is a new paragraph.

Вбудоване форматування

Ви можете зробити частину тексту курсивною або навіть напівжирною у два способи. Першим є взяття тексту у зірочки (*), а другим — взяття його у символи підкреслення (_).

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

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

Ви також можете зробити текст напівжирним курсивним поєднавши відповідне форматування. Ось так:

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

Посилання

Ви можете додавати посилання на різні сайти:

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

Ви можете використовувати внутрішні посилання:

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

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

Зображення

Ви можете вбудовувати зображення ось так:

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

Ви також можете скористатися тими самими синтаксичними конструкціями, що і для внутрішніх посилань:

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

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

Списки

Ви можете скористатися упорядкованими списками:

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

Або можете використати неупорядкований список:

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

Ви можете створювати вкладені списки:

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

Блоки коду

Ви можете додати до тексту відступ у чотири або декілька пробілів або у символ табуляції для створення блоку програмного коду:

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.

У деяких засобах перетворення Markdown, зокрема Pandoc та GitHub, ви можете скористатися зворотним апострофом Markdown у стилі GitHub для позначення блоків коду, замість додавання відступів у блоці. Ось так:

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

Наведений вище фрагмент буде, ймовірно, показано як попередньо форматований блок коду.

Фрагменти коду

Ви можете скористатися зворотним апострофом усередині абзацу для позначення коду, як із цим теґом `<html>`. Використати сам зворотний апостроф можна скориставшись декількома такими лапками поряд, як у цьому прикладі: `` `екрановані зворотний апостроф` ``.

Блоки цитат

Ви можете скористатися кутовими дужками у стилі адрес електронної пошти для визначення блоків цитування, ось так:

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

Горизонтальні лінії

Скористайтеся трьома або більшою кількістю дефісів (-), підкреслювань (_) або зірочок (*) для створення горизонтальних ліній. Ось так:

---

***
___

Ви навіть можете додати пробіли між символами:

- - -

Розширення Markdown

У деяких обробниках Markdown додано синтаксичні конструкції для таблиць, підрядкових посилань та інших елементів тексту, які розширюють початкову специфікацію Джона Ґрубера. Нижче наведено приклад використання підрядкового посилання для Pandoc, MultiMarkdown та інших обробників, де передбачено підтримку цього розширення:

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

[^footnoteid]:  Here is the footnote text.

Нижче наведено приклад таблиці Pandoc:

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

Table:  Pandoc sample table.

Нижче наведено приклад таблиці у cmark-gfm або MultiMarkdown:

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

Існує навіть більше синтаксичних конструкцій таблиць, підтримку яких передбачено у цих обробниках Markdown. Також існує набагато більше розширень. Щоб дізнатися більше про ці обробники, будь ласка, відвідайте такі сайти:

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

Початкову специфікацію Markdown Джона Ґрубера можна знайти на сторінці http://daringfireball.net/projects/markdown/.

Скорочення

У ghostwriter передбачено підтримку таких клавіатурних скорочень для редагування Markdown:

Ctrl+B

Застосувати напівжирний (виокремлений) шрифт.

Ctrl+I

Застосувати курсивний (акцентований) шрифт.

Застосувати перекреслення до тексту.

Застосувати перекреслення до тексту.

Ctrl+/

Вставити коментар HTML у позиції курсора, якщо ніякого тексту не позначено, або перетворити позначений текст на коментар HTML.

Tab

Додати відступ до позначених рядків тексту.

Shift+Tab

Вилучити відступ до позначених рядків тексту.

Вставляє розрив рядка у стилі Markdown.

Вставляє розрив рядка у стилі Markdown.

Ctrl+Enter

Вставити розрив рядка у звичний спосіб, але поточні відступи не буде взято до уваги. Іншими словами, якщо ви вводите текст на рядку з відступом і натикаєте Ctrl+Enter, до нового рядка не буде додано відступу. Зауважте, що модифікатор Ctrl можна поєднувати з модифікатором Shift для створення рядка без відступу і розриву рядка у стилі Markdown.

Ctrl+.

Перетворити поточний рядок або позначені рядки на блок цитування.

Ctrl+,

Вилучити форматування блоку цитування з поточного рядка або позначених рядків тексту.

Ctrl+8

Перетворити поточний рядок або позначені рядки на невпорядкований список з позначками *. Наприклад, якщо позначено текст у таких рядках:

  List item one.
  List item two.

Натискання цього клавіатурного скорочення перетворить позначені рядки на неупорядкований список. Ось такий:

  * List item one.
  * List item two.

Ctrl+Shift+-

  List item one.
  List item two.

  - List item one.
  - List item two.

Ctrl+Shift+=

Натискання Ctrl і Shift разом із символом = перетворює поточний рядок або позначені рядки на невпорядкований список з позначками +. Наприклад, якщо позначено текст у таких рядках:

  List item one.
  List item two.

  + List item one.
  + List item two.

Ctrl+1

Перетворити поточний рядок або позначені рядки на впорядкований список з позначками .. Наприклад, якщо позначено текст у таких рядках:

  List item one.
  List item two.

Натискання цього клавіатурного скорочення перетворить позначені рядки на нумерований список. Ось такий:

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

Ctrl+0

Перетворити поточний рядок або позначені рядки на впорядкований список з позначками ). Наприклад, якщо позначено текст у таких рядках:

  List item one.
  List item two.

Натискання цього клавіатурного скорочення перетворить позначені рядки на нумерований список. Ось такий:

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

Ctrl+T

Перетворити поточний рядок або позначені рядки на пункт списку завдань у стилі Markdown GitHub. Наприклад, якщо позначено текст у таких рядках:

  Important thing to do.
  Another important thing to do.

Натискання цього клавіатурного скорочення перетворить позначені рядки на список завдань. Ось такий:

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

Ctrl+D

Якщо поточний рядок тексту є пунктом списку завдань у стилі Markdown GitHub, натискання цієї комбінації клавіш перемкне стан завершеності завдання розташуванням x у пункті, якщо завдання завершено, або вилученням x, якщо завдання не завершено. Приклад:

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

Відповідні символи

Якщо позначено текст в одному рядку, натискання будь-якого з наведених вище символів візьме позначений текст у цей символ і його завершальний символ-відповідник. Наприклад, якщо ви позначили слово собака, а потім введете символ (, слово собака буде взято у дужки, і ви отримаєте (собака). Нижче наведено таблицю, де показано введений символ і його відповідний завершальний символ:

Початковий	Завершальний
"	"
'	'
(	)
[	]
{	}
*	*
_	_
`	`
<	>

Щоб увімкнути автоматичне додавання відповідних символів під час набирання тексту, позначте пункт «Автоматично встановлювати відповідність символів при введенні» у діалоговому вікні налаштовування програми, відкрити яке можна за допомогою пункту меню `Параметри->Налаштування...`. Ви також можете налаштувати, які символи вважатимуться відповідними, за допомогою кнопки «Налаштувати відповідні символи...».

Перетягування і скидання файлів зображень

Альтернативою до вибору пункту Зміни->Вставити зображення... на панелі меню є перетягування будь-якого файла зображення з вашої файлової системи зі скиданням його до вікна редактора. Програма вставити вбудований текст вставлення зображення із шляхом до файла зображення відносно до місця зберігання вашого поточного відкритого документа або повним шляхом до зображення, якщо документ ще не збережено. Приклад:

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

або, якщо документ немає назви:

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