Dokumentation
Inledning
Välkommen till ghostwriter! Den här snabbreferensguiden ger exempel på hur man skriver i Markdown, ett sidbeskrivningsformat för vanlig text skapat av John Gruber. För mer information, besök John Grubers webbplats på http://www.daringfireball.net.
ghostwriter har inbyggt stöd för processorn cmark-gfm. Men det kan också automatiskt upptäcka processorerna Pandoc, MultiMarkdown eller cmark. Installera helt enkelt någon av dessa processorer och se till att deras installationsplatser läggs till i systemets miljövariabel PATH
. ghostwriter upptäcker automatiskt deras installation vid start och ger dig direkt förhandsgranskning av HTML och exportalternativ i enlighet med det.
Rubriker
# Level 1 Heading
## Level 2 Heading ##
###### Level 6 Heading
Level 1 Heading
===============
some text
Level 2 Heading
---------------
some more text
Stycken
This is a paragraph.
This is another line in the same paragraph using a manual line break.
This is a new paragraph.
Formatering på plats
Du kan skapa kursiv eller till och med fetstil på två sätt. Det första är genom att omge texten med asterisker (*), medan den andra är med understreck (_).
This is *italics* with asterisks.
This is _italics_ with underscores.
This is **bold** with asterisks.
This is __bold__ with underscores.
Du kan också skapa fet kursiv stil genom att blanda och ge, så här:
This is ***bold italics*** with asterisks.
This is **_bold italics_** mixing.
This is another *__bold italics__*.
etc.
Länkar
Du kan länka till diverse webbplatser:
Click [here](http://url.com "Title") to visit a website.
Du kan också använda referenslänkar:
[This][id] is a reference link which is defined below.
[id]: http://url.com "Title"
Bilder
Du kan lägga till inbäddade bilder så här:
![alternate text](./image.jpg "Title")
Du kan också använda samma syntax som med referenslänkar:
![alternate text][id] for a reference defined below.
[id]: ./image.jpg "Title"
Listor
Du kan använda ordnade listor:
1. Item one.
2. Item two.
3. Item three.
Eller så kan du använda oordnade listor:
* Item one.
+ Item two.
- Item three.
Du kan blanda och ge med nästlade listor:
1. Item one.
* Subitem one.
* Subitem two.
2. Item two.
- Subitem one.
- Subitem two.
3. Item three.
1. Subitem three.
Kodblock
Du kan indentera fyra eller fler mellanslag eller ett tabulatortecken för att skapa ett kodblock:
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.
I vissa konverterare av Markdown, såsom Pandoc eller GitHub, kan du använda GitHub-liknande grava accenter för att avgränsa kodblock istället för att indentera blocket, så här:
```
for (int i = 0; i < 10; i++) {
System.out.println("i = " + i);
}
```
Det ovanstående visas på samma sätt som ett förformaterat kodblock.
Kodstycken
Du kan använda grava accenter i mitten av ett stycke för att avgränsa kod, som med den här taggen `<html>`
. Du kan använda tecknet grav accent genom att använda mer än en grav accent, som i det här exemplet: `` `undantagen grav accent` ``
.
Blockcitat
Du kan använda e-postliknande vinkelparenteser för att avgränsa blockcitat, enligt följande:
> This is a block quote.
>
>> This is a nested block quote.
Horisontella linjer
Använd tre eller flera streck (-), understreck (_) eller asterisker (*) för horisontella linjer, så här:
---
***
___
Du kan till och med ha mellanslag mellan varje tecken:
- - -
Utökningar av Markdown
Vissa processorer av Markdown lägger till syntax för tabeller, fotnoter och så vidare för att utöka den ursprungliga specifikationen av Markdown från John Gruber. Nedan finns ett exempel på fotnotsanvändning för Pandoc, MultiMarkdown och andra processorer som stöder tillägget:
Here is the body text that has a footnote.[^footnoteid]
[^footnoteid]: Here is the footnote text.
Nedan är ett exempel på en tabell med Pandoc:
Column One Column Two
---------- ----------
Row Text 1 Row Text 2
Row Text 1 Row Text 2
Table: Pandoc sample table.
Nedan är ett exempel på en tabell för cmark-gfm eller MultiMarkdown:
Column One | Column Two
---------- | ----------
Row Text 1 | Row Text 2
Row Text 1 | Row Text 2
Det finns ännu fler tabellsyntaxer som de här processorerna av Markdown kan stödja. Det finns också många fler tillägg. För mer information om processorerna, besök följande webbplatser:
- Pandoc: http://johnmacfarlane.net/pandoc/
- MultiMarkdown: http://fletcherpenney.net/multimarkdown/
- cmark: http://github.com/jgm/cmark/
- cmark-gfm: http://github.com/github/cmark
Den ursprungliga specifikationen av Markdown från John Gruber finns på http://daringfireball.net/projects/markdown/.
Genvägar
ghostwriter stöder följande genvägar för att redigera Markdown:
- Ctrl+B
- Tillämpar fetstil (stark) formatering.
- Ctrl+I
- Tillämpar kursiv (betonad) formatering.
- Ctrl+K
- Tillämpar överstrykningsformatering.
- Ctrl+/
- Infoga en HTML-kommentar vid markörpositionen om ingen text är markerad, eller omvandla annars markerad text till en HTML-kommentar.
- Tabulator
- Indenterar de markerade textraderna.
- Skift+Tabulator
- Avindenterar markerade textrader.
- Skift+Retur
- Infogar en radbrytning med Markdown-stil.
- Ctrl+Retur
- Infogar en radbrytning som vanligt, förutom att den aktuella indenteringarna inte respekteras. Med andra ord, om du skriver på en indenterad rad och trycker på
Ctrl+Retur
läggs ingen indentering till på den nya raden. Observera att väljartangenten Ctrl kan kombineras med väljartangenten Skift för att skapa både en rad utan indentering och en radbrytning med Markdown-stil. - Ctrl+.
- Omvandlar aktuell rad eller de markerade raderna till ett blockcitat.
- Ctrl+,
- Tar bort eventuell blockcitatformatering från aktuell rad eller de markerade textraderna.
- Ctrl+8
- Omvandlar den aktuella raden eller de markerade raderna till en punktlista med markören
*
. Till exempel, om du har markerat text inom följande rader:List item one. List item two.
Att trycka på snabbtangenten omvandlar de markerade raderna till en punktlista, så här:
* List item one. * List item two.
- Ctrl+Skift+-
- Omvandlar den aktuella raden eller de markerade raderna till en punktlista med markören
-
. Till exempel, om du har markerat text inom följande rader:List item one. List item two.
Att trycka på snabbtangenten omvandlar de markerade raderna till en punktlista, så här:
- List item one. - List item two.
- Ctrl+Skift+=
- Att trycka på
Ctrl
ochSkift
med tecknet=
omvandlar den aktuella raden eller de markerade raderna till en punktlista med markören+
. Till exempel, om du har markerat text inom följande rader:List item one. List item two.
Att trycka på snabbtangenten omvandlar de markerade raderna till en punktlista, så här:
+ List item one. + List item two.
- Ctrl+1
- Omvandlar den aktuella raden eller de markerade raderna till en nummerlista med markören
.
. Till exempel, om du har markerat text inom följande rader:List item one. List item two.
Att trycka på snabbtangenten omvandlar de markerade raderna till en numrerad lista, så här:
1. List item one. 2. List item two.
- Ctrl+0
- Omvandlar den aktuella raden eller de markerade raderna till en numrerad lista med markören
)
. Till exempel, om du har markerat text inom följande rader:List item one. List item two.
Att trycka på snabbtangenten omvandlar de markerade raderna till en numrerad lista, så här:
1) List item one. 2) List item two.
- Ctrl+T
- Omvandlar den aktuella raden eller de markerade raderna till en Markdown uppgiftslista med GitHub-stil. Till exempel, om du har markerat text inom följande rader:
Important thing to do. Another important thing to do.
Att trycka på snabbtangenten omvandlar de markerade raderna till en uppgiftslista, så här:
- [ ] Important thing to do. - [ ] Another important thing to do.
- Ctrl+D
- När den aktuella textraden är en Markdown uppgiftslista med GitHub-stil, trycker man på snabbtangenten för att ändra uppgiftens avslutningsstatus, placerar ett
x
i kryssrutan om uppgiften är klar, eller ta bortx
om den är ofullständig. Till exempel:- [ ] This is an incomplete task. - [x] This task as done!
- Matchade tecken
- När text på en enstaka rad är markerad, kommer ett tryck på något av ovanstående tecken att omge den markerade texten med tecknet och dess matchade avslutande tecken. Om du till exempel väljer ordet
hund
och sedan skriver in tecknet(
, kommer ordethund
att omges av parenteser och bli(hund)
. Nedan finns en tabell som visar det inskrivna tecknet och det matchande avslutningstecknet:Öppning Stängning " " ' ' ( ) [ ] { } * * _ _ ` ` < >
För att aktivera automatisk matchning av tecken medan du skriver, markera "Automatisk matchning av tecken medan du skriver" under fliken Editor i dialogrutan Inställningar, tillgänglig från menyraden under alternativet `Inställningar->Inställningar...`. Du kan också anpassa vilka tecken som matchas genom att använda knappen "Anpassa matchade tecken...". - Dra och släpp bildfiler
- Ett alternativ till att välja
Redigera->Infoga bild...
i menyraden är att dra och släppa valfri bildfil från filsystemet på redigeringsfönstret. Programmet infogar bildtext på plats med bildens filsökväg i förhållande till det öppnade dokumentets plats, eller hela sökvägen om dokumentet är namnlöst. Till exempel:![](../../relative/path/to/your/file.png)
eller om dokumentet är namnlöst:
![](file:///full/path/to/your/file.png)