Dokumentazioa

Sarrerakoa

Ongi etorri ghostwriterrera! Erreferentzia azkarreko gida honek, «Markdown»ekin, John Gruber-rek sortutako testu soileko marka formatu bat, idazteari buruzko adibideak ematen ditu. Informazio gehiago nahi baduzu, mesedez, bisitatu John Gruber-ren webgunea, http://www.daringfireball.net.

ghostwriterrek «cmark-gfm» prozesatzailerako euskarria barneratua du. Hala ere Pandoc, MultiMarkdown, edo «cmark» prozesatzaileak ere automatikoki hauteman ditzake. Prozesatzaile horietako edozein instalatu eta haien instalazioaren kokalekua zure sistemaren PATH ingurune-aldagaian gehitzen dela ziurtatzea besterik ez duzu egin behar. ghostwriterrek haien instalazioa abiatzean automatikoki hautemango ditu eta horren araberako HTML aurreikuspegia eta esportatzeko aukerak emango dizkizu.

Goiburu mailakatuak

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

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

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

Paragrafoak

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

This is a new paragraph.

Lerro barruko formatua

Etzana edo baita lodia ere bi eratan egin dezakezu. Lehena testua asteriskoekin inguratuz (*), bigarrena berriz azpimarra erabiliz (_).

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

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

Lodi etzanak ere egin ditzakezu, nahastuz eta binakatuz, horrela:

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

Estekak

Hainbat webgunetara estekatu dezakezu:

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

Erreferentzia estekak ere erabil ditzakezu:

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

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

Irudiak

Irudiak horrela txerta ditzakezu:

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

Erreferentzia esteken sintaxi bera ere erabil dezakezu:

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

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

Zerrendak

Zerrenda ordenatuak erabil ditzakezu:

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

Edo zerrenda ez-ordenatuak erabil ditzakezu:

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

Zerrenda habiaratuekin nahastu eta binakatu dezakezu:

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

Kode blokeak

Lau zuriune edo gehiagorekin edo tab karaktere batekin koskatu dezakezu, kode-bloke bat sortzeko:

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 bihurtzaile batzuetan, Pandoc edo GibHub esaterako, blokea koskatu ordez, GitHub-tankerako Markdown-en azentu kamutsa erabil dezakezu kode blokeak mugatzeko, horrela:

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

Goikoa ere azalduko da aurre-formateatutako kode-bloke bat bezala.

Kode bitarteak

Paragrafo baten erdian azentu kamutsak erabil ditzakezu kodea mugatzeko, `<html>` etiketa honetan bezala. Azentu kamuts literalak erabil ditzakezu jarraian azentu kamuts bat baina gehiago erabiliz, adibide honetan bezala: `` `ihes egindako azentu kamutsa` ``.

Bloke aipuak

e-posta estiloko parentesi angeludunak erabil ditzakezu bloke aipuak mugatzeko, ondokoen antzera:

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

Lerro horizontalak

Erabili hiru gidoi (-), azpimarra (_), edo asterisko (*) edo gehiago lerro horizontaletarako, horrela:

---

***
___

Karaktereen artean zuriuneak ere ipin ditzakezu:

- - -

«Markdown»en hedapenak

Markdown prozesatzaile batzuek, taula, orri-oin, eta halakoetarako sintaxia gehitzen dute, John Grub-en «Markdown»erako zehaztapena hedatzeko. Behean orri-oin erabileraren adibide bat dago, «Pandoc», «MultiMarkdown», eta hedapena onartzen duten beste prozesatzaile batzuetarako:

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

[^footnoteid]:  Here is the footnote text.

Behean «Pandoc» taula baten adibidea:

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

Table:  Pandoc sample table.

Behean «cmark-gfm» edo «MultiMarkdown» taula baten lagina:

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

Markdown prozesatzaile horiek oraindik eta taula-sintaxi gehiago onartzen dituzte. Askoz hedapen gehiago ere badaude. Prozesatzaile horien gaineko informazioa gehiagorako, mesedez, bisitatu ondoko webguneak:

John Gruber-ren jatorrizko Markdown zehaztapenak http://daringfireball.net/projects/markdown/ helbidean aurki daitezke.

Lasterbideak

ghostwriterrek Markdown editatzeko ondoko lasterbideak onartzen ditu:

Ktrl+B
Formatu lodia (sendoa) ezartzen du.
Ktrl+I
Formatu etzana (enfasia) ezartzen du.
Ktrl+K
Formatu marratua ezartzen du.
Ktrl+/
Testurik aukeratzen ez bada, HTML iruzkin bat txertatzen du kurtsorea dagoen kokalekuan, edo bestela aukeratutako testua HTML iruzkin bihurtuko du.
Tab
Aukeratutako testu lerroetan koska txertatzen du.
Maius+Tab
Aukeratutako testu lerroetan koska kentzen du.
Maius+Sartu
Markdown estiloko lerro jauzi bat txertatzen du.
Ktrl+Sartu
Lerro haustura ohi bezala txertatzen du, uneko koskatzea beteko ez dela salbu. Beste era batean esanda, koska duen lerro batean tekleatzen ari zarela Ktrl+Sartu sakatzen baduzu, lerro berriari ez zaio koskarik ipiniko. Kontuan izan Ktrl aldarazlea Maius. aldarazlearekin konbinatu daitekeela, koskarik gabeko eta Markdown-estiloko lerro haustura bat sortzeko.
Ktrl+.
Uneko lerroa, edo hautatutako lerroak aipamen-bloke bihurtzen ditu.
Ktrl+,
Uneko testu lerroko, edo hautatutako lerroetako aipamen-bloke oro kentzen ditu.
Ktrl+8
Uneko lerroa edo hautatutako lerroak * markatzailea duen bulet-zerrenda bilakatzen du. Adibidez, ondoko lerroetako testua hautatu baduzu:
  List item one.
  List item two.

Lasterbide-tekla hori sakatzean hautatutako lerroak bulet zerrenda bihurtuko dira, horrela:

  * List item one.
  * List item two.
Ktrl+Maius+-
Uneko lerroa edo hautatutako lerroak - markatzailea duen bulet-zerrenda bilakatzen du. Adibidez, ondoko lerroetako testua hautatu baduzu:
  List item one.
  List item two.

Lasterbide-tekla hori sakatzean hautatutako lerroak bulet zerrenda bihurtuko dira, horrela:

  - List item one.
  - List item two.
Ktrl+Maius+=
Ktrl eta Maius = karakterearekin batera sakatzea, uneko lerroa edo hautatutako lerroak + markatzailea duen bulet-zerrenda bilakatzen ditu. Adibidez, ondoko lerroetako testua hautatu baduzu:
  List item one.
  List item two.

Lasterbide-tekla hori sakatzean hautatutako lerroak bulet zerrenda bihurtuko dira, horrela:

  + List item one.
  + List item two.
Ktrl+1
Uneko lerroa edo hautatutako lerroak . markatzailea duen zenbakitutako zerrenda bilakatzen ditu. Adibidez, ondoko lerroetako testua hautatu baduzu:
  List item one.
  List item two.

Lasterbide-tekla hori sakatzean hautatutako lerroak zerrenda zenbakitubihurtuko dira, horrela:

  1. List item one.
  2. List item two.
Ktrl+0
Uneko lerroa edo hautatutako lerroak ) markatzailea duen zenbakitutako zerrenda bilakatzen ditu. Adibidez, ondoko lerroetako testua hautatu baduzu:
  List item one.
  List item two.

Lasterbide-tekla hori sakatzean hautatutako lerroak zerrenda zenbakitubihurtuko dira, horrela:

  1) List item one.
  2) List item two.
Ktrl+T
Uneko lerroa edo hautatutako lerroak GitHub-tankerako Markdown ataza-zerrendako elementu bilakatzen ditu. Adibidez, ondoko lerroetako testua hautatu baduzu:
  Important thing to do.
  Another important thing to do.

Lasterbide-tekla hori sakatzean hautatutako lerroak zeregin zerrenda bihurtuko dira, horrela:

  - [ ] Important thing to do.
  - [ ] Another important thing to do.
Ktrl+D
Uneko testu-lerroa GitHub-tankerako Markdown ataza-zerrendako elementu bat denean, lasterbide-tekla hori sakatzea atazaren osatze egoera txandakatuko du, egiaztapen-laukian x bat ipiniz ataza osatuta dagoenean, edo x kenduz osatzeke dagoenean. Adibidez:
  - [ ] This is an incomplete task.
  - [x] This task as done!
Bat datozen karaktereak
Lerro bakarreko testua hautatzen denean, goiko karaktereetako edozein sakatzean, hautatutako testua karaktere hori eta hari dagokion ixteko karakterearekin inguratuko da. Adibidez, txakurra hitza hautatu eta ondoren ( karakterea sartzen baduzu, txakurra hitza parentesi artean bildu eta (txakurra) bilakatuko da. Azpian dago tekleatutako karakterea eta ixteko dagokion karakterearen taula bat:

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

Tekleatu ahala karaktereen bat-etortze automatikoa gaitzeko, markatu "Tekleatu bitartean karaktereak automatikoki bat-etortzea", Hobespenak elkarrizketa-koadroko Editorea fitxan, menu-barrako 'Ezarpenak->Hobespenak...' aukeran erabilgarri. Zein karaktere bat-etorri ere neurrira ipin dezakezu "Bat-etortzeko karaktereak neurrira ipini..." botoia hautatuz..
Irudi-fitxategiak arrastatu eta jaregitea
Menu-barrako Editatu->Txertatu irudia... aukera hautatzearen ordez, zure fitxategi-sistemako irudi-fitxategiak editorearen leihora arrastatu eta jaregin ditzakezu. Aplikazioak, lerro barruan, irudiari dagokion testua txertatuko du, unean irekitako dokumentuaren kokalekuarekiko irudi-fitxategiaren bide-izen erlatiboarekin, edo dokumentuak izenbururik ez badu, bide-izen osoarekin. Adibidez:

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

edo dokumentuak izenbururik ez badu:

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