Az osztott ablakos elrendezés
A dokumentációs szerkesztő két, egymás melletti panelt tartalmaz:
- Bal panel — oldalfa: az aktuális kategória összes oldalát egy összecsukható fastruktúraként jeleníti meg. Kattints egy oldalra a szerkesztőben való megnyitáshoz. Bármely oldalon a hárompontos helyi menüt használva gyermek-oldalakat adhatsz hozzá, rendezhetsz, tehetsz közzé, vonhatsz vissza közzétételt, vagy törölhetsz. Új gyökéroldalakat az alján lévő gombbal adhatsz hozzá.
- Jobb panel — tartalomszerkesztő: a kijelölt oldal címét, leírását, a közzétett kapcsolót és a markdown törzsszöveg-szerkesztőt mutatja. A módosítások a Mentés gombbal kerülnek mentésre.
Alapszintű markdown-szintaxis
| Elem | Szintaxis |
|---|---|
| 1-es szintű fejezetcím | # Fejezetcím |
| 2-es szintű fejezetcím | ## Fejezetcím |
| Félkövér | **szöveg** |
| Dőlt | *szöveg* |
| Inline kód | `kód` |
| Hivatkozás | [felirat](https://url) |
| Kép |  |
| Felsorolásos lista | - elem |
| Számozott lista | 1. elem |
| Idézet | > szöveg |
| Vízszintes elválasztó | --- |
Táblázatok
A markdown-táblázatok függőleges vonalakkal (pipe) határozzák meg az oszlopokat:
| A oszlop | B oszlop |
|----------|----------|
| Cella 1 | Cella 2 |A második sor (kötőjelek) kötelező. Az oszlopokat kettőspontokkal igazíthatod: :--- bal, :---: közép, ---: jobb.
Kódblokkok
A többsoros kódot hármas backtick karakterekkel zárd közre. Opcionálisan megadhatsz egy nyelvi azonosítót megjelenítési célból:
```javascript
const greeting = "hello";
```MDC-komponensek
A Yaplet dokumentáció a standard markdown-on túl beépített komponenseket is támogat. Ezek a ::komponensnév szintaxist használják. A leggyakoribbak:
- ::note és ::callout — kiemelt információ-, figyelmeztetés- vagy tipp-dobozok.
- ::steps — vizuális összekötőkkel ellátott számozott lépéslista.
- ::card-group / ::card — ikonokkal és címekkel ellátott infókártyák rácsa.
- ::accordion — összecsukható, GYIK-stílusú szakaszok.
- ::tabs — füles tartalompanelek.
Az egyes komponensek teljes szintaxispéldáiért kattints a Súgó gombra a markdown-szerkesztő eszköztárában — ez megnyit egy szerkesztőn belüli referenciadokumentumot másolásra kész példákkal.
AI-asszisztencia
Az szerkesztő eszköztárán három AI-gomb található:
- AI Tartalom — egyetlen asszisztens az oldal törzsszövegéhez: írd le, mit szeretnél, vagy válassz egy gyorsműveletet (Írás folytatása, Javítás, Nyelvtan javítása, Rövidítés), ha az oldalon már van tartalom. Kapcsolódó oldalakat vagy súgócikkeket is csatolhatsz kontextusként, az eredmény pedig előnézetként jelenik meg — finomíthatod egy követő utasítással, vagy elfogadhatod; semmi sem változik, amíg el nem fogadod.
- AI Cím — tömör címet generál az oldal törzsszövege alapján.
- AI Leírás — egymonatos oldal-leírást ír a törzsszöveg alapján.
Mentés és előnézet
Kattints a Mentés gombra a módosítások rögzítéséhez. Ha nem mentett módosításokkal próbálsz navigálni el, a szerkesztő figyelmeztet. Kattints az Előnézet gombra az aktuális markdown megjelenített nézetéhez — ez pontosan megmutatja, hogyan fog kinézni az oldal a látogatóknak közzététel után.