Dokumentáció
A Dokumentáció oldal egy nyilvános doksz oldal a termékedhez, többkategóriás oldalsáv navigációval, tartalomjegyzékkel, teljes szöveges kereséssel és markdown megjelenítéssel — mindezt a widgeted aldomainjén hosztolva.
Áttekintés
A Dokumentáció oldal egy strukturált, fejlesztőbarát doksz oldalt biztosít a {your-widget-id}.yaplet.help/d címen. Technikai dokumentációhoz, termékútmutatókhoz, API referenciákhoz és bármilyen tartalomhoz tervezték, ami hasznot húz hierarchikus navigációs struktúrából oldalsávval és tartalomjegyzékkel.
Oldalsáv navigáció
Összecsukható fa oldalsáv az oldalak és beágyazott szekciók közötti navigáláshoz.
Teljes szöveges keresés
Keresés az összes oldalcímben, leírásban és tartalomban kiemelt eredményekkel.
Tartalomjegyzék
Automatikusan generált TOC görgetésfigyelővel, amely kiemeli az aktuális szekciót.
Kategória fülek
A dokumentáció szervezése több kategóriába, mindegyiknek saját oldalfával.
Hogyan működik
A Dokumentáció oldalad elérhető a következő címen:
https://{widget-id}.yaplet.help/d
Cseréld ki a {widget-id} részt a widgeted URL azonosítójára, amelyet a Widget beállítások > Általános > Widget URL alatt találsz.
Amikor egy látogató a /d címre érkezik, automatikusan átirányítódik az első kategóriához és annak első oldalához.
Oldal elrendezés
A Dokumentáció oldal háromoszlopos elrendezést használ:
| Oszlop | Pozíció | Tartalom |
|---|---|---|
| Oldalsáv | Bal (320px) | Oldalfa összecsukható szekciókkal |
| Tartalom | Közép (max 768px) | Az oldal tartalma markdown-ként megjelenítve |
| Tartalomjegyzék | Jobb (264px) | Automatikusan generált H2 és H3 címsorokból |
Mobil eszközökön az oldalsáv és TOC csúszó paneleken érhető el, amelyeket az oldal tetején lévő gombok aktiválnak.
Navigáció
- Előző / Következő linkek jelennek meg minden oldal alján, megkönnyítve a dokumentáció szekvenciális olvasását
- Morzsastílusú URL-ek tükrözik az oldal hierarchiát:
/d/guides/getting-started/installation - Csoport oldalak (csoportként jelölt vagy tartalom nélküli oldalak) automatikusan az első gyermekoldalukra irányítanak
Kategóriák
Ha a dokumentációd több kategóriával rendelkezik, egy fülsáv jelenik meg a fejléc alatt. Minden fül egy másik kategóriához vezet, és rákattintva betölti annak oldalfáját az oldalsávba.
Keresés
A keresősáv minden oldalon középen a fejlécben található. Az eredmények teljes képernyős felületen jelennek meg, találat típus szerint csoportosítva:
- Cím találatok — oldalak, ahol a cím megegyezik a lekérdezéseddel
- Leírás találatok — oldalak, ahol a leírás megegyezik
- Tartalom találatok — oldalak, ahol a szövegtörzs megegyezik, kiemelt részletekkel
Nyomd meg az Escape billentyűt a keresési felület bezárásához.
Tartalom megjelenítés
A dokumentáció oldalak Markdown-ban íródnak és az MDC (Markdown Components) motor segítségével jelennek meg. Ez azt jelenti, hogy az oldalaid tartalmazhatnak:
- Szabványos markdown-t (címsorok, listák, táblázatok, kódblokkok, képek)
- Gazdag komponenseket, mint kiemelések, kártyák, fülek, lépések és kódcsoportok
- Szintaxiskiemelt kódot fájlnév címkékkel és sorkiemeléssel
Másolás LLM-hez
Minden oldalon van egy "Copy page for LLM" gomb, amely a nyers markdown tartalmat a vágólapra másolja. Ez hasznos dokumentáció beillesztéséhez AI eszközökbe elemzés vagy kérdésmegválaszolás céljából.
Márkázás és stílus
A Dokumentáció oldal támogatja az egyéni márkázást:
- Világos és sötét logók — Tölts fel külön logókat mindkét szín módhoz a Dokumentáció beállításaiban. Ezek a fejlécben jelennek meg és automatikusan váltanak.
- Sötét/Világos mód váltó — A látogatók a fejlécben lévő váltóval válthatnak a sötét és világos téma között.
Ha nincsenek logók konfigurálva, a dokumentáció címe szövegként jelenik meg.
Widget integráció
Amikor a Dokumentáció csatlakoztatva van a widgetedhez:
- AI betanítás — A dokumentáció teljes tartalma felhasználásra kerül a csatlakoztatott AI chatbot betanításához, így a dokumentációd alapján válaszolhat kérdésekre
- Widget-beli linkek — A Tudásbázis kezdőlap linkeket jeleníthet meg a dokumentációdra
A Yaplet chat widget szintén be van ágyazva a Dokumentáció oldalakon, így a látogatók bármikor indíthatnak beszélgetést a dokumentáció olvasása közben.
Oldal hierarchia
A dokumentáció oldalak korlátlan beágyazási mélységet támogatnak. Ilyen struktúrákat hozhatsz létre:
Útmutatók (kategória)
├── Első lépések
│ ├── Telepítés
│ ├── Konfiguráció
│ └── Kezdő lépések
├── Haladó témák
│ ├── Hitelesítés
│ └── Webhookok
└── API Referencia
├── Végpontok
└── Hibakódok
Csoport oldalak szekciófejelcekként működnek — az oldalsávban kibontható csomópontokként jelennek meg, de nincs saját tartalmuk. Kattintáskor kibontják a gyermekoldalakat és az első gyermekoldalra irányítanak.