Dokumentacija
Uvod
Dobrodošli v ghostwriter! Ta hitri referenčni vodnik ponuja primere pisanja v Markdownu, formatu označevanja navadnega besedila, ki ga je ustvaril John Gruber. Za več informacij obiščite spletno stran Johna Gruberja na http://www.daringfireball.net.
ghostwriter ima vgrajeno podporo za procesor cmark-gfm. Vendar pa lahko tudi samodejno zazna procesorje Pandoc, MultiMarkdown ali cmark. Enostavno namestite katerega koli od teh procesorjev in zagotovite, da so lokacije njihove namestitve dodane v sistemsko spremenljivko okolja PATH. ghostwriter bo samodejno zaznal njihovo namestitev ob zagonu in vam omogočil živi predogled HTML-ja in ustrezno možnosti izvoza.
Glave
# Level 1 Heading
## Level 2 Heading ##
###### Level 6 Heading
Level 1 Heading
===============
some text
Level 2 Heading
---------------
some more text
Odstavki
This is a paragraph.
This is another line in the same paragraph using a manual line break.
This is a new paragraph.
Oblikovanje znotraj vrstice
Poševno ali celo krepko lahko naredite na dva načina. Prvo tako da besedilo obdajajo zvezdice (*), drugo pa podčrtaji (_).
This is *italics* with asterisks.
This is _italics_ with underscores.
This is **bold** with asterisks.
This is __bold__ with underscores.
Prav tako lahko naredite krepko poševno z mešanjem in ujemanjem, takole:
This is ***bold italics*** with asterisks.
This is **_bold italics_** mixing.
This is another *__bold italics__*.
etc.
Povezave
Lahko se povežete z različnimi spletnimi stranmi:
Click [here](http://url.com "Title") to visit a website.
Uporabite lahko tudi referenčne povezave:
[This][id] is a reference link which is defined below.
[id]: http://url.com "Title"
Slike
Slike lahko vdelate takole:
Uporabite lahko tudi isto sintakso kot pri referenčnih povezavah:
![alternate text][id] for a reference defined below.
[id]: ./image.jpg "Title"
Seznami
Lahko uporabite urejene sezname:
1. Item one.
2. Item two.
3. Item three.
Ali lahko uporabite neurejene sezname:
* Item one.
+ Item two.
- Item three.
Lahko mešate in ujemate z ugnezdenimi seznami:
1. Item one.
* Subitem one.
* Subitem two.
2. Item two.
- Subitem one.
- Subitem two.
3. Item three.
1. Subitem three.
Bloki kode
Če želite ustvariti blok kode, lahko zamikate s štirimi ali več presledki ali tabulatorskim znakom:
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.
V nekaterih pretvornikih Markdowna, kot sta Pandoc ali GitHub, lahko uporabite dialekt github Markdownove povratni apostrofe za razmejitev kodnih blokov, namesto da bi se zamikanja blokov, nekako tako:
```
for (int i = 0; i < 10; i++) {
System.out.println("i = " + i);
}
```
Zgornje bo tudi prikazano kot predhodno oblikovan blok kode.
Razponi kode
Za razmejitev kode lahko na sredini odstavka uporabite obratne opuščaje, kot pri tej znački `<html>`. Dobesedne obratne opuščaje uporabite tako, da uporabite več kot en obraten opuščaj, kot v naslednjem primeru: `` `primer` ``.
Citirani odstavek
Za razmejitev blokov kode lahko uporabite ostre oklepaje kot pri e-pošti, kot sledi:
> This is a block quote.
>
>> This is a nested block quote.
Vodoravne črte
Uporabite tri ali več pomišljajev (-), podčrtajev (_) ali zvezdic (*) za vodoravne črte, takole:
---
***
___
Med posameznimi znaki lahko celo postavite presledke:
- - -
Razširitve Markdovna
Nekateri procesorji Markdown dodajo sintakso za tabele, sprotne opombe in podobno kot razširitev izvirne specifikacije John Gruber za Markdown. Spodaj je primer uporabe opombe za Pandoc, MultiMarkdown in druge procesorje, ki podpirajo razširitev:
Here is the body text that has a footnote.[^footnoteid]
[^footnoteid]: Here is the footnote text.
Spodaj je vzorec tabele za Pandoc:
Column One Column Two
---------- ----------
Row Text 1 Row Text 2
Row Text 1 Row Text 2
Table: Pandoc sample table.
Spodaj je vzorec tabele za cmark-gfm ali MultiMarkdown:
Column One | Column Two
---------- | ----------
Row Text 1 | Row Text 2
Row Text 1 | Row Text 2
Obstaja še več sintaks tabel, ki jih lahko podpirajo procesorji za Markdown. Obstaja tudi veliko več razširitev. Za več informacij o teh procesorjih, obiščite naslednja spletišča:
- Pandoc: http://johnmacfarlane.net/pandoc/
- MultiMarkdown: http://fletcherpenney.net/multimarkdown/
- cmark: http://github.com/jgm/cmark/
- cmark-gfm: http://github.com/github/cmark
Izvirno specifikacijo Markdowna od Johna Gruberja lahko najdete na http://daringfireball.net/projects/markdown/.
Bližnjice
ghostwriter podpira naslednje bližnjice za urejanje Markdowna:
- Kontrolka+B
- Uveljavi krepko (močno) oblikovanje.
- Kontrolka+I
- Uveljavi poševno (poudarjeno) oblikovanje.
- Kontrolka+K
- Uveljavi prečrtano oblikovanje.
- Kontrolka+/
- Vstavi komentar HTML na položaj kazalke, če ni izbrano nobeno besedilo, ali pa se bo izbrano besedilo spremenilo v HTML komentar.
- Tab
- Zamakne izbrane vrstice besedila.
- Dvigalka+Tab
- Od-zamakne izbrane vrstice besedila.
- Dvigalka+Enter
- Vstavi prelom vrstice v slogu Markdowna.
- Kontrolka+Enter
- Vstavi prelom vrste kot običajno, razen da ne upošteva trenutnega zamika. Z drugimi besedami, če tipkate v zamaknjeni vrsti in pritisnete
kontrolka+enter, v novi vrstici ne bo dodanega zamika. Upoštevajte, da je modifikator kontrolke mogoče kombinirati z modifikatorjem dvigalke, da ustvarite nezamaknjeno vrsto kot prelom vrstice v slogu Markdowna. - Kontrolka+.
- Pretvori trenutno vrstico ali izbrane vrstice v citirani odstavek.
- Kontrolka+,
- Odstrani oblikovanje citiranega odstavka iz trenutne vrstice ali izbranih vrstic besedila.
- Kontrolka+8
- Pretvori trenutno vrstico ali izbrane vrstice v neurejen seznam z oznako
*. Na primer, če ste izbrali besedilo znotraj naslednjih vrstic:List item one. List item two.Če pritisnete na to bližnjico tipkovnice, boste izbrane vrstice spremenili v neurejeni seznam npr.:
* List item one. * List item two. - Kontrolka+Dvigalka+-
- Pretvori trenutno vrstico ali izbrane vrstice v neurejeni seznam z oznako
-. Na primer, če ste izbrali besedilo znotraj naslednjih vrstic:List item one. List item two.Če pritisnete na to bližnjico tipkovnice, boste izbrane vrstice spremenili v neurejeni seznam npr.:
- List item one. - List item two. - Kontrolka+Dvigalka+=
- Pritisk kontrolke in dvigalke s tipko '=' pretvori trenutno vrstico ali izbrane vrstice v neurejeni seznam z oznako
+. Na primer, če ste izbrali besedilo v naslednjih vrsticah:List item one. List item two.Če pritisnete na to bližnjico tipkovnice, boste izbrane vrstice spremenili v neurejeni seznam npr.:
+ List item one. + List item two. - Kontrolka+1
- Pretvori trenutno vrstico ali izbrane vrstice v oštevilčeni seznam z oznako
.. Na primer, če imate izbrano besedilo v naslednjih vrsticah:List item one. List item two.Če pritisnete na bližnjico tipkovnice, boste izbrane vrstice spremenili v oštevilčeni seznam npr:
1. List item one. 2. List item two. - Kontrolka+0
- Pretvori trenutno vrstico ali izbrane vrstice v oštevilčeni seznam z oznako
). Na primer, če imate izbrano besedilo v naslednjih vrsticah:List item one. List item two.Če pritisnete na bližnjico tipkovnice, boste izbrane vrstice spremenili v oštevilčeni seznam npr:
1) List item one. 2) List item two. - Kontrolka+T
- Pretvori trenutno vrstico ali izbrane vrstice v element seznama opravil Markdown po vzoru GitHuba. Primer: če ste izbrali besedilo v naslednjih vrsticah:
Important thing to do. Another important thing to do.Če pritisnete na to bližnjico tipkovnice, boste izbrane vrstice spremenili v seznam opravil npr.:
- [ ] Important thing to do. - [ ] Another important thing to do. - Kontrolka+D
- Če je trenutna vrstica besedila element seznama opravil Markdown po vzoru GitHuba, s to kombinacijo tipk preklopite stanje opravljenosti opravila, tako da postavite
xin v potrditveno polje, če je opravilo dokončano, ali odstranitex, če ni dokončano. Primer:- [ ] This is an incomplete task. - [x] This task as done! - Ujemanje znakov
- Ko je izbrano besedilo v eni vrstici, pritisnite kateregakoli od zgornjih znakov bo s tem obkrožil izbrano besedilo s tem znakom in njegovim ujemajočim zaključnim znakom. Na primer, če izberete besedo
pesin nato vnesete znak oklepaj(bo besedapeszaprta z zaklepajem in bo postala(pes). Spodaj je tabela, ki prikazuje začetne znake z ustreznim zaključnim znakom:Odpiranje Zapiranje " " ' ' ( ) [ ] { } * * _ _ ` ` < >
Če želite omogočiti samodejno ujemanje znakov med tipkanjem, odkljukajte "Samodejno ujemanje z znaki, medtem ko tipkate" v zavihku Urejevalnik v pogovornem oknu Preferenc, ki je na voljo v menijski vrstici pod `Nastavitve->Preference...`. Prav tako lahko prilagodite, kateri znaki naj se ujemajo z gumbom "Prilagodite ujemajoče znake...". - Povleci in spusti datoteke slik
- Alternativa izbiri
Uredi->Vstavi sliko...v menijski vrstici je, da povlečete in spustite katero koli slikovno datoteko iz svojega datotečnega sistema v okno urejevalnika. Aplikacija bo vstavila v vrstico besedilo slike s potjo datoteke vaše slike glede na trenutno odprto lokacijo dokumenta ali celotno pot, če je dokument brez naslova. Na primer:ali če dokument nima naslova:
