TSDocs.dev: type docs for any JavaScript library

• DocFX

  18 3,885 9.8 C#

  Static site generator for .NET API documentation.

  

This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool?

https://docs.oracle.com/javase/8/docs/technotes/tools/window...

https://dotnet.github.io/docfx/

I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!

• jQuery

  166 58,862 8.5 JavaScript

  jQuery JavaScript Library

  

Great reference.

To this date, one of the best well-documented code is jQuery: https://github.com/jquery/jquery/blob/main/src/core/init.js

I learned a lot from looking into the code.

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• tsdocs

  1 1,074 9.4 TypeScript

  Browse type documentation for JS libraries

Yeah, this is known, thanks! https://github.com/pastelsky/tsdocs/issues/9

• rust

  2,682 92,831 10.0 Rust

  Empowering everyone to build reliable and efficient software.

  

• docs.rs

  139 943 9.5 Rust

  crates.io documentation generator

  

Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

• ts-results-es

  1 37 8.3 TypeScript

  A TypeScript implementation of Rust's Result and Option.

  

Suggest a related project