Slate API Docs Generator

Slate API Docs Generator

Skiffer - vacker statisk dokumentation för din API.Features
Skiffer - vacker statisk dokumentation för ditt API.Funktioner Ren, intuitiv design - Med Slate finns beskrivningen av ditt API till vänster om din dokumentation, och alla kodexempel finns på höger sida.Inspirerad av Stripes och Paypals API-dokument.Skiffer är lyhörd, så det ser bra ut på surfplattor, telefoner och även i tryck.Allt på en enda sida - Borta är de dagar då dina användare var tvungna att söka igenom en miljon sidor för att hitta vad de ville ha.Skiffer lägger hela dokumentationen på en enda sida.Vi har dock inte offret länkbarhet.När du bläddrar kommer din webbläsares hash att uppdateras till närmaste rubrik, så att länka till en viss punkt i dokumentationen är fortfarande naturligt och enkelt.Skiffer är bara Markdown - När du skriver dokument med Skiffer skriver du bara Markdown, vilket gör det enkelt att redigera och förstå.Allt är skrivet i Markdown - även kodproven är bara Markdown-kodblock.Skriv kodprover på flera språk - Om ditt API har bindningar på flera programmeringsspråk kan du enkelt lägga till flikar för att växla mellan dem.I ditt dokument kommer du att skilja olika språk genom att ange språknamnet högst upp i varje kodblock, precis som med Github Flavored Markdown.Syntaxmarkering utanför boxen för nästan 60 språk, ingen konfiguration krävs.Automatisk, smidig rullande innehållsförteckning längst till vänster på sidan.När du bläddrar visas den nuvarande positionen i dokumentet.Det är också snabbt.Vi använder Slate på TripIt för att bygga dokumentation för vårt nya API, där vår innehållsförteckning har över 180 poster.Vi har sett till att prestandan förblir utmärkt, även för större dokument.
slate-api-docs-generator

kategorier

Alternativ till Slate API Docs Generator för Node.JS

swagger.io

swagger.io

Swagger är en öppen källkods RESTapi dokumentationsverktyg.