Slate API Docs Generator Reviews and details

Social recommendations and mentions

• How do i document my api ?

  Https://github.com/slatedocs/slate this ! Big company use it ( stripe etc ). Source: about 1 year ago

• [ARTICLE] Stripe Releases Their Documentation Framework

  The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." － so then Slate gets brought up as a suitable replacement. Source: almost 2 years ago

• Twelve Amazing Free Hugo Documentation Themes

  DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.​​​​​​. - Source: dev.to / almost 2 years ago

• Best way to document Express API

  I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code. Source: almost 2 years ago

• Building API Docs

  We used to use Slate - https://github.com/slatedocs/slate for our APIs in my previous job. That was pretty neat. - Source: Hacker News / about 2 years ago

• What is the Stripe API docs written in ?

  Stripe rolled their own API documentation. For something close, I'd recommend Slate. Here are a few examples of Slate in the wild:. Source: about 2 years ago

• What would you like to see Stripe improve on iOS?

  I'm using Slate right now which is a common recommendation for Stripe-like documentation, but obviously it's not the same. Source: over 2 years ago

• Favorite API Documentation UI/UX

  While not as visually impressive with flashy graphics and UI elements, Twilio's documentation has similar Stripe vibes as I believe it's built on Slate which is about as close to Stripe's framework as you can get. I like the theme used[4] in the code sample section as it's a nice break from the standard colors and it's easy on the eyes. Source: almost 3 years ago

• I know it's in beta, but the API is confusing and the docs aren't great

  The API docs look like Slate docs, which are cool in theory but usually terribly implemented: Non-resizable columns, poorly synchronized scrolling, everything in one page (why is this ever advertised as advantageous?). Source: almost 3 years ago

• Best toolset/workflow for prototyping and iterating an API?

  That's about the API design and specification. Now let's turn our attention to API UIs for visualisation and interaction. API UIs are useful for other people to easily understand your API. Again, quite a variety of choices in this area, but the most common are Swagger UI and Redoc. Lots of frameworks and tools will allow you to render the Swagger or Redoc UI of an OpenAPI spec from the specification document, such... Source: almost 3 years ago

• Most best/most popular API documentation tools?

  Swagger UI and the likes are API visualisation tools - they're UIs. They make it easier for humans to understand the API and play around with it. I find Swagger UI the most straightforward to work with, but it does look a bit less impressive. As an alternative, you may want to consider the Redoc UI. I don't have experience with Spring, but I'd be surprised if it doesn't have the ability to render Redoc UIs.... Source: almost 3 years ago

• Best platform for writing api docs?

  For API-specific docs I use Slate as I like the code sample section off to the right. I converted our previous severely lacking Swagger setup to a full-featured framework with Slate that has significantly reduced the number of support emails regarding API questions. Source: about 3 years ago

• 21 tools to document your Python project

  Slate and friends. The next step towards a more controlled evolution of the API documentation is a tool like Slate and the API documentation in git. It's still text that you need to write manually in Markdown, but Slate provides a structure, a slick renderer, and lets you publish your API as an independent website. - Source: dev.to / about 3 years ago