A dokumentációs oldal beállítása

1. Hozz létre egy dokumentációt

1. Menj ide: Dashboard → Dokumentáció.
2. Kattints az Új dokumentáció gombra.
3. Add meg a címet (pl. „Fejlesztői útmutató" vagy „API-referencia").
4. Mentsd el. A dokumentáció megjelenik a listában.

Több dokumentációt is létrehozhatsz — termékenként, célközönségenként vagy nyelvenként egyet-egyet. Minden dokumentáció független, saját kategóriákkal, oldalakkal és widget-kapcsolatokkal.

2. Adj hozzá kategóriákat

A kategóriák navigációs fülekként jelennek meg a nyilvános dokumentációs oldalon. Gondolj rájuk fejezetekként: „Első lépések", „API-referencia", „Konfiguráció".

1. Kattints az új dokumentációdba.
2. Kattints az Új kategória gombra.
3. Add meg a nevet és egy opcionális leírást.
4. Ismételd, amennyi kategóriára szükséged van.

Ha csak egy kategóriád van, a navigációs fülsáv el van rejtve a nyilvános oldalon, a tisztább olvasási élmény érdekében. A rendezéssel és a legjobb gyakorlatokkal kapcsolatban lásd: hogyan szervezd a dokumentáció kategóriáit.

3. Adj hozzá oldalakat

Egy kategórián belül egy oldalsort építesz — az oldalaknak lehetnek gyermek-oldalaik, amelyeknek szintén lehetnek saját gyermekeik, annyi szinten, amennyire szükséged van.

1. Nyiss meg egy kategóriát (kattints a nevére a dokumentáció nézetben).
2. A bal oldali fastruktúra panelen kattints az Gyökér elem hozzáadása lehetőségre (a panel alján).
3. Add meg a címet a jobb oldali szerkesztőpanelen, és írd meg a tartalmat a markdown-szerkesztőben.
4. Gyermek-oldal hozzáadásához nyisd meg a szülő-oldal hárompontos menüjét, és válaszd a Gyermek hozzáadása lehetőséget. Olyan oldalaknál, amelyeknek már vannak gyermekei, a gyermeklista végén megjelenik egy + Gyermek hozzáadása link is.

4. Csatlakoztasd egy widgethez

A dokumentáció csak akkor érhető el nyilvánosan, ha egy widgethez van csatlakoztatva. A widget biztosítja a nyilvános URL-t és szabályozza a vizuális arculatot.

1. Menj ide: Dashboard → Widgetek → [a te widgeted].
2. Nyisd meg az Általános fület, és görgess le a Kapcsolatok szekcióhoz.
3. Válaszd ki a dokumentációdat a Dokumentáció legördülő listából, majd mentsd el.

A dokumentációd ettől fogva elérhető a https://{widget-subdomain}.yaplet.help/d/ URL-en. A dokumentáció elsődleges nyelvét (alapértelmezetten angol) és a világos/sötét módú logókat itt változtathatod meg: Dashboard → Dokumentáció → [a te dokumentációd] → Beállítások.

5. Tedd közzé

A tartalmakat közzé kell tenni, mielőtt nyilvánosan láthatóvá válnának. A közzététel kétlépéses folyamat: először a kategória, majd a benne lévő oldalak. A teljes közzétételi folyamatért és a tömeges közzételi parancsokért lásd: Dokumentáció közzététele nyilvános URL-re.