Slate API Docs Generator VS JSDoc

Slate API Docs Generator Reviews

JSDoc Reviews

Slate API Docs Generator mentions (13)

• 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

JSDoc mentions (48)

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / about 2 months ago

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 2 months ago

• What is JSDoc and why you may not need typescript for your next project?

  There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / 3 months ago

• TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc

  JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools. - Source: dev.to / 3 months ago

• Adding a search feature to my app

  Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and... - Source: dev.to / 6 months ago