16
Slate API Docs Generator
Skrilavec - lepa statična dokumentacija za vaše API.Features
- Brezplačna
- Self-Hosted
- Mac
- Linux
Skrilavec - lepa statična dokumentacija za vaš API.Značilnosti Čist, intuitiven dizajn - Pri Slate je opis API-ja na levi strani vaše dokumentacije, vsi primeri kod pa na desni strani.Navdih za dokumente API-ja Stripe in Paypal.Skrilavec je odziven, zato izgleda odlično na tablicah, telefonih in celo v tisku.Vse na eni strani - Gotovo so dnevi, ko so morali vaši uporabniki iskati po milijon strani, da so našli tisto, kar so želeli.Skrilavec postavi celotno dokumentacijo na eno stran.Nismo pa žrtvovali povezljivosti.Ko se pomikate, se bo hash brskalnika posodobil na najbližjo glavo, zato je povezava do določene točke dokumentacije še vedno naravna in enostavna.Skrilavec je samo Markdown - Ko pišete dokumente s programom Slate, samo pišete Markdown, kar omogoča preprosto urejanje in razumevanje.Vse je zapisano v Markdownu - tudi vzorci kode so samo Markdown kodni bloki.Pisanje vzorcev kode v več jezikih - Če ima vaš API vezi v več programskih jezikih, jih lahko preprosto vstavite v zavihke, da preklopite med njimi.V svojem dokumentu boste razlikovali različne jezike tako, da boste na vrhu vsakega bloka kod določili ime jezika, tako kot pri Github okusu Markdown.Označevanje skladenj v okencu za skoraj 60 jezikov, konfiguracija ni potrebna.Samodejno in gladko pomikanje po vsebini na skrajni levi strani.Med premikanjem se prikaže vaš trenutni položaj v dokumentu.Tudi hitro gre.Slate na TripIt uporabljamo za izdelavo dokumentacije za naš novi API, kjer ima naša vsebina več kot 180 vnosov.Poskrbeli smo, da zmogljivost ostaja odlična, tudi pri večjih dokumentih.