Documentação
Introdução
Bem-vindo ao ghostwriter! Esta guia de referência rápido dá-lhe exemplos de escrita em Markdown, um formato de texto criado por John Gruber. Para mais informações, visite por favor a página Web do John Gruber em http://www.daringfireball.net.
O ghostwriter tem o suporte incorporado para o processador 'cmark-gfm'. Contudo, também consegue detectar o Pandoc, MultiMarkdown ou 'cmark'. Basta instalar algum desses processadores e garantir que os locais de instalação dos mesmos constam na variável de ambiente PATH do seu sistema. O ghostwriter irá detectar a sua instalação no arranque, dando-lhe uma antevisão do HTML em directo e as opções de exportação respectivas.
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 Incorporada
Consegue escrever em itálico ou mesmo em negrito de duas formas. Uma é envolvendo 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.
Até consegue escrever em negrito e itálico se os misturar, como por exemplo:
This is ***bold italics*** with asterisks.
This is **_bold italics_** mixing.
This is another *__bold italics__*.
etc.
Hiperligações
Poderá referenciar várias páginas Web:
Click [here](http://url.com "Title") to visit a website.
Também poderá usar ligações de referências:
[This][id] is a reference link which is defined below.
[id]: http://url.com "Title"
Imagens
Poderá incorporar imagens da seguinte forma:
Também poderá usar a mesma sintaxe que as ligações de referências:
![alternate text][id] for a reference defined below.
[id]: ./image.jpg "Title"
Listas
Poderá usar lista ordenadas:
1. Item one.
2. Item two.
3. Item three.
Ou não ordenadas:
* Item one.
+ Item two.
- Item three.
Poderá misturar e criar correspondências com listas encadeadas:
1. Item one.
* Subitem one.
* Subitem two.
2. Item two.
- Subitem one.
- Subitem two.
3. Item three.
1. Subitem three.
Blocos de Código
Poderá indentar com quatro ou mais espaços ou uma 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 de Markdown, como o Pandoc ou o GitHub, poderá usar os acentos graves da variante do GitHub para delimitar blocos de código em vez de indentar o código, como se segue:
```
for (int i = 0; i < 10; i++) {
System.out.println("i = " + i);
}
```
O excerto acima será também apresentado como um bloco de código pré-formatado.
Código Incorporado
Poderá usar os acentos graves a meio de um parágrafo para delimitar código, como acontece nesta marca `<html>`. Poderá usar acentos graves literais se usar mais que um acento, como neste exemplo: `` `acento escapado` ``.
Citações de Blocos
Poderá usar os sinais de maior, como nos e-mails, para delimitar citações em bloco, como se segue:
> This is a block quote.
>
>> This is a nested block quote.
Linhas Horizontais
Use três ou mais hífenes (-), sublinhados (_) ou asteriscos (*) para as linhas horizontais, como se segue:
---
***
___
Até poderá ter espaços entre cada carácter:
- - -
Extensões do Markdown
Alguns processadores de Markdown adicionam a sintaxe para as tabelas, notas de rodapé e outros itens para estender a especificação de Markdown original do John Gruber. Em baixo, encontra-se um exemplo de utilização de notas de rodapé no 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.
Segue-se uma tabela de exemplo em Markdown:
Column One Column Two
---------- ----------
Row Text 1 Row Text 2
Row Text 1 Row Text 2
Table: Pandoc sample table.
Segue-se uma tabela de exemplo em cmark-gfm ou MultiMarkdown:
Column One | Column Two
---------- | ----------
Row Text 1 | Row Text 2
Row Text 1 | Row Text 2
Existem ainda mais sintaxes de tabelas do que as que estes processadores de Markdown suportam. Existem também ainda mais extensões. Para mais informações sobre estes processadores, visite por favor as seguintes páginas Web:
- Pandoc: http://johnmacfarlane.net/pandoc/
- MultiMarkdown: http://fletcherpenney.net/multimarkdown/
- cmark: http://github.com/jgm/cmark/
- cmark-gfm: http://github.com/github/cmark
A especificação original do Markdown, feita por John Gruber, pode ser encontrada em http://daringfireball.net/projects/markdown/.
Atalhos
O ghostwriter suporta os seguintes atalhos para editar o Markdown:
- Ctrl+B
- Aplica a formatação em negrito.
- Ctrl+I
- Aplica a formatação em itálico (ênfase).
- Ctrl+K
- Aplica a formatação traçada.
- Ctrl+/
- Insere um comentário de HTML na posição do cursor, caso não tenha texto seleccionado, ou então irá transformar o texto seleccionado num comentário em HTML.
- Tab
- Indenta as linhas de texto seleccionadas.
- Shift+Tab
- Remove a indentação das linhas de texto seleccionadas.
- Shift+Enter
- Insere uma quebra de linha ao estilo do Markdown.
- Ctrl+Enter
- Insere uma quebra de linha como de costume, excepto que a indentação actual não será respeitada. Por outras palavras, se estiver a escrever uma linha indentada e carregar em
Ctrl+Enter, não será adicionada nenhuma indentação à nova linha. Lembre-se que o modificador Ctrl pode ser combinado com o Shift para produzir uma linha sem indentação e uma quebra de linha ao estilo do Markdown. - Ctrl+.
- Transforma a linha actual ou as linhas seleccionadas numa citação em bloco.
- Ctrl+,
- Remove a formatação de citação em bloco a linha actual ou das linhas de texto seleccionadas.
- Ctrl+8
- Transforma a linha actual ou as linhas seleccionadas numa lista de tópicos com o marcador
*. Por exemplo, se tiver seleccionado o texto dentro das seguintes linhas:List item one. List item two.Se carregar nesta combinação de teclas, irá transformar as linhas numa lista com tópicos, como a seguinte:
* List item one. * List item two. - Ctrl+Shift+-
- Transforma a linha actual ou as linhas seleccionadas numa lista de tópicos com o marcador
-. Por exemplo, se tiver seleccionado o texto dentro das seguintes linhas:List item one. List item two.Se carregar nesta combinação de teclas, irá transformar as linhas numa lista com tópicos, como a seguinte:
- List item one. - List item two. - Ctrl+Shift+=
- Se carregar no 'Ctrl' e no 'Shift' e depois carregar em '=', transforma a linha actual ou as linhas seleccionadas numa lista de tópicos com o marcador
+. Por exemplo, se tiver seleccionado o texto dentro das seguintes linhas:List item one. List item two.Se carregar nesta combinação de teclas, irá transformar as linhas numa lista com tópicos, como a seguinte:
+ List item one. + List item two. - Ctrl+1
- Transforma a linha actual ou as linhas seleccionadas numa lista numerada com o marcador
.. Por exemplo, se tiver seleccionado o texto dentro das seguintes linhas:List item one. List item two.Se carregar nesta combinação de teclas, irá transformar as linhas seleccionadas numa lista numerada como a seguinte:
1. List item one. 2. List item two. - Ctrl+0
- Transforma a linha actual ou as linhas seleccionadas numa lista numerada com o marcador
). Por exemplo, se tiver seleccionado o texto dentro das seguintes linhas:List item one. List item two.Se carregar nesta combinação de teclas, irá transformar as linhas seleccionadas numa lista numerada como a seguinte:
1) List item one. 2) List item two. - Ctrl+T
- Transforma a linha actual ou as linhas seleccionadas num item de lista de tarefas ao estilo do Markdown do GitHub. Por exemplo, se tiver seleccionado o texto dentro das seguintes linhas:
Important thing to do. Another important thing to do.Se carregar nesta combinação de teclas, irá transformar as linhas seleccionadas numa lista de tarefas como a seguinte:
- [ ] Important thing to do. - [ ] Another important thing to do. - Ctrl+D
- Quando a linha de texto actual é um item de listas de tarefas em Markdown do GitHub, ao carregar neste atalho irá comutar o estado finalizado da tarefa; se colocar um
xna opção de marcação, significa que a tarefa está completa, e se o retirar, significa que está incompleta. Por exemplo:- [ ] This is an incomplete task. - [x] This task as done! - Caracteres Correspondentes
- When text within a single line is selected, pressing any of the above characters will enclose the selected text with that character and its matching closing character. For example, if you select the word
dogand then enter the(character, the worddogwill be enclosed in parentheses and become(dog). Below is a table showing the typed character and the matching closing character:Abertura Fecho " " ' ' ( ) [ ] { } * * _ _ ` ` < >
To enable auto-matching of characters as you type, check "Automatically match characters while typing" from the Editor tab in the Preferences dialog, available from the menu bar under the `Settings->Preferences...` option. You can also customize which characters are matched by selecting the "Customize matched characters..." button. - Arrastamento de Ficheiros de Imagens
- Como alternativa à selecção da opção
Editar->Inserir uma Imagem..., poderá arrastar e largar qualquer ficheiro de imagem do seu sistema de ficheiros sobre a janela do editor. A aplicação irá inserir o texto de imagem incorporada com a localização relativa da sua imagem para a localização do documento aberto, ou então a localização completa se o documento ainda não tiver nome. Por exemplo:ou, caso o documento não tenha nome:
