Slate API Docs Generator

Slate API Docs Generator

Skrilac - prekrasna statička dokumentacija za vaše API.Features
Slate - prekrasna statička dokumentacija za vaš API.Značajke Čist, intuitivan dizajn - Pomoću Slate opis vašeg API-ja nalazi se na lijevoj strani vaše dokumentacije, a svi primjeri koda nalaze se na desnoj strani.Inspirirani dokumentima API-ja Stripe i Paypal.Skrivanje je prilagodljivo pa izgleda izvrsno na tabletima, telefonima, pa čak i u tisku.Sve na jednoj stranici - Prošli su dani kada su vaši korisnici morali pretraživati ​​milijun stranica kako bi pronašli ono što žele.Slate cjelokupnu dokumentaciju stavlja na jednu stranicu.Nismo žrtvovali povezanost.Dok se krećete, hash vašeg preglednika ažurirat će se na najbliže zaglavlje, tako da je povezivanje s određenom točkom u dokumentaciji i dalje prirodno i jednostavno.Slate je samo Markdown - Kad pišete dokumente sa Slate, vi samo pišete Markdown, što olakšava uređivanje i razumijevanje.Sve piše u Markdownu - čak su i uzorci koda samo Markdown kodovi blokova.Pisanje uzoraka koda na više jezika - Ako vaš API ima povezivanje na više programskih jezika, možete lako staviti u kartice za prebacivanje između njih.U svom dokumentu ćete razlikovati različite jezike tako što ćete na vrhu svakog bloka koda odrediti naziv jezika, baš kao i kod Github aromatizirane Markdown.Istaknuće sintaksa izvan okvira za gotovo 60 jezika, nije potrebna konfiguracija.Automatsko, glatko pomicanje sadržaja na krajnjem lijevom dijelu stranice.Dok se krećete, prikazat će se vaš trenutni položaj u dokumentu.Također je brzo.Koristimo Slate na TripIt-u za izradu dokumentacije za naš novi API gdje naš sadržaj sadrži preko 180 unosa.Pobrinuli smo se da izvedba ostane izvrsna, čak i za veće dokumente.
slate-api-docs-generator

Kategorije

Alternativa Slate API Docs Generatoru za Software as a Service (SaaS) sa licencom otvorenog koda