Slate API Docs Generator

Slate API Docs Generator

Skifer - smuk statisk dokumentation til din API.Features
Skifer - smuk statisk dokumentation til din API.Funktioner Rent, intuitivt design - Med skifer er beskrivelsen af ​​din API i venstre side af din dokumentation, og alle kodeeksempler er på højre side.Inspireret af Stripes og Paypals API-dokumenter.Skifer er lydhør, så det ser godt ud på tabletter, telefoner og endda på trykt.Alt på en enkelt side - Borte er de dage, hvor dine brugere måtte søge gennem en million sider for at finde, hvad de ønskede.Skifer placerer hele dokumentationen på en enkelt side.Vi har dog ikke ofret linkbarhed.Når du ruller, opdateres browserens hash til den nærmeste overskrift, så det er stadig naturligt og let at linke til et bestemt punkt i dokumentationen.Skifer er bare Markdown - Når du skriver dokumenter med Skifer, skriver du bare Markdown, hvilket gør det enkelt at redigere og forstå.Alt er skrevet i Markdown - selv kodeprøverne er kun Markdown-kodeblokke.Skriv kodeeksempler på flere sprog - Hvis din API har bindinger i flere programmeringssprog, kan du nemt lægge i faner for at skifte mellem dem.I dit dokument skelner du forskellige sprog ved at specificere sprognavnet øverst i hver kodeblok, ligesom med Github-smagsfuld markering.Udenfor boksen syntaks fremhævning på næsten 60 sprog, ingen konfiguration kræves.Automatisk, jævnt rullende indholdsfortegnelse længst til venstre på siden.Når du ruller, viser det din aktuelle position i dokumentet.Det er også hurtigt.Vi bruger Slate på TripIt til at oprette dokumentation til vores nye API, hvor vores indholdsfortegnelse har over 180 poster.Vi har sørget for, at ydelsen forbliver fremragende, selv for større dokumenter.
slate-api-docs-generator

Kategorier

Alternativer til Slate API Docs Generator til Software as a Service (SaaS) med gratis licens