Documentação

Introdução

Bem-vindo ao ghostwriter! Este guia de referência rápida oferece exemplos de como escrever em Markdown, um formato de marcação de texto simples criado por John Gruber. Para mais informações, visite o site de John Gruber em http://www.daringfireball.net.

O ghostwriter possui suporte integrado para o processador cmark-gfm. No entanto, ele também pode detectar automaticamente os processadores Pandoc, MultiMarkdown ou cmark. Basta instalar qualquer um desses processadores e garantir que seus locais de instalação sejam adicionados à variável de ambiente PATH do seu sistema. O ghostwriter detectará automaticamente a instalação na inicialização e fornecerá uma visualização HTML ao vivo e opções de exportação adequadas.

Cabeçalhos

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

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

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

Parágrafos

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

This is a new paragraph.

Formatação em linha

Você pode usar itálico ou até mesmo negrito de duas maneiras. A primeira é delimitando o texto com asteriscos (*), enquanto a segunda é com sublinhados (_).

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

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

Você também pode fazer negrito e itálico misturando e combinando, assim:

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

Você pode criar links para vários sites:

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

Você também pode usar links de referência:

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

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

Imagens

Você pode incorporar imagens assim:

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

Você também pode usar a mesma sintaxe dos links de referência:

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

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

Listas

Você pode usar listas ordenadas:

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

Ou você pode usar listas não ordenadas:

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

Você pode misturar e combinar com listas aninhadas:

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

Blocos de código

Você pode recuar com quatro ou mais espaços ou um caractere de tabulação para criar um bloco de código:

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.

Em alguns conversores Markdown, como Pandoc ou GitHub, você pode usar as crases do Markdown com o GitHub para delimitar blocos de código em vez de recuar o bloco, assim:

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

O acima também será exibido como um bloco de código pré-formatado.

Intervalos de código

Você pode usar acentos graves no meio de um parágrafo para delimitar o código, como com esta tag `<html>```. Você pode usar acentos graves literais usando mais de um acento grave, como neste exemplo: ``` `acento grave escapado` ```.

Blocos de citação

Você pode usar colchetes angulares no estilo de e-mail para delimitar citações em bloco, da seguinte maneira:

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

Réguas horizontais

Use três ou mais traços (-), sublinhados (_) ou asteriscos (*) para regras horizontais, como:

---

***
___

Você pode até ter espaços entre cada caractere:

- - -

Extensões do Markdown

Alguns processadores Markdown adicionam sintaxe para tabelas, notas de rodapé e assim por diante para estender a especificação Markdown original de John Gruber. Abaixo está um exemplo de uso de notas de rodapé para Pandoc, MultiMarkdown e outros processadores que suportam a extensão:

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

[^footnoteid]:  Here is the footnote text.

Abaixo está um exemplo de tabela do Pandoc:

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

Table:  Pandoc sample table.

Abaixo está um exemplo de tabela cmark-gfm ou MultiMarkdown:

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

Há ainda mais sintaxes de tabela que esses processadores Markdown podem suportar. Há também muitas outras extensões. Para mais informações sobre esses processadores, visite os seguintes sites:

A especificação original do Markdown de John Gruber pode ser encontrada em http://daringfireball.net/projects/markdown/.

Atalhos

O ghostwriter suporta os seguintes atalhos para edição de Markdown:

Ctrl+B
Aplica formatação em negrito (forte).
Ctrl+I
Aplica formatação itálica (ênfase).
Ctrl+K
Aplica formatação tachada.
Ctrl+/
Insere um comentário HTML na posição do cursor se nenhum texto for selecionado, ou senão transformará o texto selecionado em um comentário HTML.
Tab
Recua as linhas de texto selecionadas.
Shift+Tab
Desfaz o recuo das linhas de texto selecionadas.
Shift+Enter
Insere uma quebra de linha no estilo Markdown.
Ctrl+Enter
Insere uma quebra de linha como de costume, exceto que o recuo atual não será honrado. Em outras palavras, se você estiver digitando em uma linha recuada e pressionar Ctrl+Enter, nenhum recuo será adicionado à nova linha. Observe que o modificador Ctrl pode ser combinado com o modificador Shift para produzir uma linha sem recuo e uma quebra de linha no estilo Markdown.
Ctrl+.
Transforma a linha atual ou as linhas selecionadas em uma citação em bloco.
Ctrl+,
Remove qualquer formatação de citação em bloco da linha atual ou das linhas de texto selecionadas.
Ctrl+8
Transforma a linha atual ou as linhas selecionadas em uma lista com marcadores com o marcador *. Por exemplo, se você selecionou texto dentro das seguintes linhas:
  List item one.
  List item two.

Pressionar esta tecla de atalho transformará as linhas selecionadas em uma lista com marcadores como esta:

  * List item one.
  * List item two.
Ctrl+Shift+-
Transforma a linha atual ou as linhas selecionadas em uma lista com marcadores com o marcador -. Por exemplo, se você selecionou texto dentro das seguintes linhas:
  List item one.
  List item two.

Pressionar esta tecla de atalho transformará as linhas selecionadas em uma lista com marcadores como esta:

  - List item one.
  - List item two.
Ctrl+Shift+=
Pressionar Ctrl e Shift com o caractere = transforma a linha atual ou as linhas selecionadas em uma lista com marcadores com o marcador +. Por exemplo, se você selecionou texto dentro das seguintes linhas:
  List item one.
  List item two.

Pressionar esta tecla de atalho transformará as linhas selecionadas em uma lista com marcadores como esta:

  + List item one.
  + List item two.
Ctrl+1
Transforma a linha atual ou as linhas selecionadas em uma lista numerada com o marcador .. Por exemplo, se você selecionou texto dentro das seguintes linhas:
  List item one.
  List item two.

Pressionar esta tecla de atalho transformará as linhas selecionadas em uma lista numerada como esta:

  1. List item one.
  2. List item two.
Ctrl+0
Transforma a linha atual ou as linhas selecionadas em uma lista numerada com o marcador ). Por exemplo, se você selecionou texto dentro das seguintes linhas:
  List item one.
  List item two.

Pressionar esta tecla de atalho transformará as linhas selecionadas em uma lista numerada como esta:

  1) List item one.
  2) List item two.
Ctrl+T
Transforma a linha atual ou as linhas selecionadas em um item da lista de tarefas do GitHub Markdown. Por exemplo, se você selecionou texto dentro das seguintes linhas:
  Important thing to do.
  Another important thing to do.

Pressionar esta tecla de atalho transformará as linhas selecionadas em uma lista de tarefas como esta:

  - [ ] Important thing to do.
  - [ ] Another important thing to do.
Ctrl+D
Quando a linha de texto atual for um item da lista de tarefas do Markdown com o GitHub, pressionar esta tecla de atalho alternará o status de conclusão da tarefa, colocando um x na caixa de seleção se a tarefa estiver concluída ou removendo o x se estiver incompleta. Por exemplo:
  - [ ] This is an incomplete task.
  - [x] This task as done!
Caracteres correspondidos
Quando o texto dentro de uma única linha é selecionado, pressionar qualquer um dos caracteres acima irá delimitar o texto selecionado com esse caractere e seu caractere de fechamento correspondente. Por exemplo, se você selecionar a palavra cachorro e, em seguida, inserir o caractere (, a palavra cachorro será delimitada entre parênteses e se tornará (cachorro). Abaixo está uma tabela mostrando o caractere digitado e o caractere de fechamento correspondente:

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

Para habilitar a correspondência automática de caracteres enquanto você digita, marque a opção "Corresponder caracteres automaticamente ao digitar" na aba Editor da janela de Preferências, disponível na barra de menu, na opção `Configurações->Preferências...`. Você também pode personalizar quais caracteres serão correspondidos selecionando o botão "Personalizar caracteres correspondidos...".
Arrastar e soltar arquivos de imagem
Uma alternativa à seleção da opção Editar->Inserir Imagem... na barra de menu é arrastar e soltar qualquer arquivo de imagem do seu sistema de arquivos na janela do editor. O aplicativo inserirá o texto da imagem em linha com o caminho do arquivo da sua imagem em relação à localização do documento atualmente aberto, ou o caminho completo se o documento não tiver título. Por exemplo:

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

ou se o documento não tiver título:

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