16
Slate API Docs Generator
Bridlica - krásna statická dokumentácia pre vaše API.Funkcie
- Bezplatná
- Self-Hosted
- Mac
- Linux
Bridlica - krásna statická dokumentácia pre vaše API.Funkcie Čistý a intuitívny dizajn - Slate, popis vášho API je na ľavej strane vašej dokumentácie a všetky príklady kódu sú na pravej strane.Inšpirované dokumentmi rozhrania API spoločnosti Stripe a Paypal.Bridlica je citlivá, takže vyzerá skvele na tabletoch, telefónoch a dokonca aj v tlači.Všetko na jednej stránke - Preč sú dni, keď vaši používatelia museli prehľadávať milión stránok, aby našli, čo hľadali.Slate umiestni celú dokumentáciu na jednu stránku.Neobetovali sme však prepojiteľnosť.Pri posúvaní sa hash vášho prehliadača aktualizuje na najbližšiu hlavičku, takže prepojenie na konkrétny bod v dokumentácii je stále prirodzené a ľahké.Slate je len Markdown - Keď píšete dokumenty so Slate, píšete len Markdown, čo uľahčuje editáciu a porozumenie.Všetko je napísané v Markdown - dokonca aj ukážky kódu sú iba Markdown kódové bloky.Písanie ukážok kódu vo viacerých jazykoch - Ak má vaše rozhranie API väzby vo viacerých programovacích jazykoch, môžete medzi nimi jednoducho prepínať karty.V dokumente budete rozlišovať rôzne jazyky zadaním názvu jazyka v hornej časti každého bloku kódu, rovnako ako v prípade Github Flavored Markdown.Predvolené zvýraznenie syntaxe pre takmer 60 jazykov, nevyžaduje sa žiadna konfigurácia.Automatické, plynulé posúvanie obsahu úplne vľavo od stránky.Počas posúvania zobrazuje vašu aktuálnu polohu v dokumente.Je to tiež rýchle.Používame Slate na TripIt na zostavenie dokumentácie pre naše nové API, kde náš obsah má viac ako 180 záznamov.Zabezpečili sme, aby výkon zostal vynikajúci, dokonca aj pre väčšie dokumenty.
WebSite:
https://github.com/tripit/slateKategórie
Alternatívy programu Slate API Docs Generator pre Software as a Service (SaaS) s komerčnou licenciou
1
Docuie
Docuie poskytuje cenovo dostupnú dokumentáciu pre jednotlivých vývojárov až po podnikových zákazníkov.Nastavenie dokumentácie je veľmi jednoduché a vyžaduje iba niekoľko kliknutí.
- Platená
- Software as a Service (SaaS)