Slate API Docs Generator

Slate API Docs Generator

Břidlice - krásná statická dokumentace pro vaše API.Features
Břidlice - krásná statická dokumentace pro vaše API.Funkce Čistý, intuitivní design - Slate, popis vašeho API je na levé straně vaší dokumentace a všechny příklady kódu jsou na pravé straně.Inspirováno dokumenty API Stripe a Paypal.Slate je citlivý, takže vypadá skvěle na tabletech, telefonech a dokonce i v tisku.Vše na jedné stránce - Pryč jsou dny, kdy uživatelé museli prohledat milion stránek, aby našli to, co hledali.Slate umístí celou dokumentaci na jednu stránku.Přesto jsme však neobětovali propojitelnost.Při posouvání se hash prohlížeče aktualizuje na nejbližší hlavičku, takže propojení s konkrétním bodem v dokumentaci je stále přirozené a snadné.Slate je jen Markdown - Když píšete dokumenty se Slate, píšete jen Markdown, což usnadňuje editaci a porozumění.Vše je zapsáno v Markdown - i ukázky kódu jsou pouze Markdown kódové bloky.Psaní ukázek kódu ve více jazycích - Pokud vaše API obsahuje vazby ve více programovacích jazycích, můžete mezi nimi snadno přepínat karty.V dokumentu budete rozlišovat různé jazyky zadáním názvu jazyka v horní části každého bloku kódu, stejně jako u Github Flavored Markdown.Out-of-the-box zvýraznění syntaxe pro téměř 60 jazyků, není nutná žádná konfigurace.Automatické, plynulé posouvání obsahu zcela vlevo na stránce.Při posouvání zobrazuje vaši aktuální polohu v dokumentu.Je to také rychlé.Používáme Slate na TripIt k vytváření dokumentace pro naše nové API, kde náš obsah obsahuje přes 180 položek.Zajistili jsme, aby výkon zůstal vynikající i pro větší dokumenty.
slate-api-docs-generator

Kategorie

Alternativy k Slate API Docs Generator pro Microsoft Visual Studio s licencí open source