Megosztás
A dokumentáció megosztás lehetővé teszi nyilvános linkek generálását a dokumentációs tartalmaidhoz a csatlakoztatott widgeteken keresztül. Ezek a linkek külső hozzáférést biztosítanak a dokumentációs oldalaidhoz, miközben megőrzik az egységes arculatot és navigációt.
Widget kiválasztás
Dokumentációs tartalom megosztásakor több widget közül választhatsz, mert egyetlen dokumentáció több widgethez is csatolható. Ez a kapcsolat lehetővé teszi, hogy ugyanaz a dokumentációs tartalom különböző widget felületeken keresztül legyen elérhető.
Minden widget egy különböző nyilvános felületet képvisel, ahol a dokumentációs tartalmad megtekinthető. Amikor egy dokumentáció több widgethez van rendelve, a megosztás modal az összes csatlakoztatott widgethez elérhető, lehetővé téve, hogy kiválaszd, melyik widget URL struktúráját használd a megosztáshoz.
Nyilvános dokumentációs oldalak
A generált linkek nyilvános dokumentációs oldalakra irányítanak, amelyek ugyanazt a dizájnt használják, mint a hozzájuk tartozó widget. Ez azt jelenti, hogy a megosztott dokumentációs tartalom vizuális megjelenése és arculata megegyezik azzal a widgettel, amelyen keresztül megosztották.
Linktípusok oldalakhoz
Egyedi dokumentációs oldalak megosztásakor a modal két különböző linktípust biztosít, eltérő előnyökkel:
Közvetlen link (struktúra alapú)
- URL struktúra: Kategória/oldal neveket használ az útvonalban
- Példa:
/d/getting-started/installation - Előnyök: Ember által olvasható, SEO-barát
- Hátrányok: Elromlik, ha a nevek változnak (kategória vagy oldal név módosítások)
- Legjobb: Google indexeléshez, chat linkekhez, ideiglenes megosztáshoz
Fix link (azonosító alapú)
- URL struktúra: Oldal azonosítót használ állandó hivatkozáshoz
- Példa:
/d/redirect?id=abc123 - Előnyök: Soha nem romlik el átszervezés vagy névváltoztatás miatt
- Hátrányok: Kevésbé olvasható, nem SEO-optimalizált
- Legjobb: Dokumentációhoz, állandó hivatkozásokhoz, API integrációkhoz