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

Введение

Добро пожаловать в ghostwriter! Это краткое справочное руководство содержит примеры записи в Markdown — формате разметки простого текста, созданном John Gruber. Дополнительные сведения приведены на сайте 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, для выделения блоков кода можно использовать обратные кавычки GitHub-Flavored Markdown вместо отступа блока, как показано ниже:

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

Приведённый выше текст также будет показан как блок кода с предварительным форматированием.

Фрагменты кода

Можно использовать обратные кавычки в середине абзаца для выделения кода, как в этом теге `<html>`. Чтобы получить буквальные обратные кавычки, нужно поставить больше одной обратной кавычки, как в этом примере: `` `escaped backtick` ``.

Блоки цитат

Для выделения блочных цитат можно использовать угловые скобки, как в электронной почте:

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

Горизонтальные линии

Можно использовать три или более дефиса (-), подчёркивания (_) или звёздочки (*) для горизонтальных линий, например:

---

***
___

Можно даже ставить пробелы между символами:

- - -

Расширения Markdown

Некоторые обработчики Markdown добавляют синтаксис для таблиц, сносок и так далее, расширяя исходную спецификацию Markdown John Gruber. Ниже приведён пример использования сносок для 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, созданная John Gruber, приведена по адресу http://daringfireball.net/projects/markdown/.

Комбинации клавиш

ghostwriter поддерживает следующие комбинации клавиш для редактирования Markdown:

Ctrl+B

Применяет полужирное форматирование (strong).

Ctrl+I

Применяет курсив (emphasis).

Ctrl+K

Применяет зачёркивание.

Ctrl+/

Вставляет комментарий HTML в позицию курсора, если текст не выделен, иначе преобразует выделенный текст в комментарий HTML.

Tab

Увеличивает отступ выделенных строк текста.

Shift+Tab

Уменьшает отступ выделенных строк текста.

Shift+Enter

Вставляет перенос строки в стиле 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

Преобразует текущую строку или выделенные строки в элемент списка задач GitHub-Flavored Markdown. Например, если выделен текст в следующих строках:

  Important thing to do.
  Another important thing to do.

Нажатие этой комбинации клавиш преобразует выделенные строки в список задач, как показано ниже:

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

Ctrl+D

Если текущая строка текста — элемент списка задач GitHub-Flavored Markdown, нажатие этой комбинации клавиш переключает состояние выполнения задачи: если задача выполнена, во флажок добавляется x, а если нет — x удаляется. Например:

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

Сопоставляемые символы

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

Открывающий	Закрывающий
"	"
'	'
(	)
[	]
{	}
*	*
_	_
`	`
<	>

Чтобы включить автоматическое сопоставление символов при вводе, установите флажок «Автоматически сопоставлять символы при вводе» на вкладке «Редактор» в диалоговом окне «Параметры», которое открывается из строки меню в разделе `Настройка → Параметры…`. Кроме того, можно настроить, какие символы сопоставляются, нажав кнопку «Настроить сопоставляемые символы…».

Перетаскивание файлов изображений

Вместо выбора пункта Правка → Вставить изображение… в строке меню можно перетащить любой файл изображения из файловой системы в окно редактора. Приложение вставит встроенный текст изображения с путём к файлу изображения относительно расположения текущего открытого документа или полный путь, если документ не имеет имени. Например:

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

или если документ не имеет имени:

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