Slate API Docs Generator

Slate API Docs Generator

Bridlica - krásna statická dokumentácia pre vaše API.Funkcie
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.
slate-api-docs-generator

Kategórie

Alternatívy Slate API Docs Generator pre všetky platformy s akoukoľvek licenciou

Doxygen

Doxygen

Doxygen je nástroj na vytváranie dokumentácie z anotovaných zdrojov C ++, ako aj iných populárnych programovacích jazykov, ako sú C, Objective-C, C #, PHP, Java, Python, IDL (CORBA ...
swagger.io

swagger.io

Swagger je open source dokumentačný nástroj RESTapi.
Daux.io

Daux.io

Daux.io je generátor dokumentácie, ktorý používa jednoduchú štruktúru priečinkov a súbory Markdown na vytvorenie vlastnej dokumentácie za chodu.Pomáha vám vytvárať skvelo vyzerajúcu dokumentáciu spôsobom priateľským pre vývojárov.
Docsie

Docsie

Docsie je bezplatný softvér na spoluprácu pre správu softvérových dokumentov, intranetov a znalostí.Jednoducho vytvorte svoju softvérovú dokumentáciu v Docsie a vložte ju na svoj web alebo do vnútorného portálu pomocou reťazca JavaScriptu.
  • Bezplatná
  • Web
Wikitten

Wikitten

Wikitten je malá hostovaná wiki, ktorá je kompatibilná s Markdown a HTML stránkami a je priateľská voči Git.
Sandcastle

Sandcastle

Spoločnosť Sandcastle vytvára presnú, komplexnú dokumentáciu v štýle MSDN, ktorá odráža zdrojové zostavy a voliteľne integruje komentáre k dokumentácii XML.
Codex

Codex

Codex je jednoduchá platforma dokumentácie Markdown založená na vrchole Laravelu.Je to úplne prispôsobiteľné a mŕtve jednoduché použitie na vytvorenie krásnej dokumentácie.
ReadMe

ReadMe

ReadMe je úplne prispôsobiteľné a spolupracujúce miesto pre dynamické API a / alebo produktovú dokumentáciu.
NDoc

NDoc

NDoc generuje dokumentáciu knižnice tried zo zostáv .NET a súbory dokumentácie XML generované kompilátorom C # (alebo pomocou doplnkového nástroja pre VB.NET).
DoxyS

DoxyS

DoxyS je nástroj na dokumentáciu kódu pre C ++ / C.DoxyS sa snaží poskytovať veľmi profesionálny vzhľad a prezentovať kód v štruktúrovanej ľahko navigovateľnej sade stránok HTML.
CppDoc

CppDoc

CppDoc generuje HTML dokumentáciu pre triedy C ++ na základe vášho zdrojového kódu a špeciálnych poznámok, ktoré sú v nej zabudované.
Docuie

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í.
Document! X

Document! X

Dokument!X je kombináciou automatizovaného dokumentačného nástroja a úplného vývojového prostredia, ktoré možno použiť na vytváranie, publikovanie a udržiavanie presnej dokumentácie v profesionálnej kvalite pre .NET, webové služby, databázy, XSD, Java, Javascript.
Aglio

Aglio

aglio - vykresľovač API Blueprint, ktorý podporuje viacero tém a výstupov statického HTML, ktoré môže obsluhovať ktorýkoľvek webový hostiteľ.
Natural Docs

Natural Docs

Natural Docs je generátor dokumentácie s otvoreným zdrojovým kódom pre viacero programovacích jazykov.Dokument zdokumentujete v prirodzenej syntaxi, ktorá znie ako obyčajná angličtina.