• Stars
    star
    1,034
  • Rank 42,946 (Top 0.9 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created 7 months ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Browse type documentation for JS libraries

tsdocs.dev

TSDocs.dev is a service that lets you browse type reference documentation for Javascript packages.

It works even with packages that aren't written in Typescript (sourced from DefinitelyTyped) or when packages re-export types from other packages.

Its depends heavily on a customized version of typedoc for generating API docs documentation.

Writing good documentation for your library

tsdocs.dev extracts documentation from the type definitions that ships with libraries. In case a type definition is unavailable, it searches DefinitelyTyped for the closest equivalent.

For an example, see documentation for d3 β€” https://tsdocs.dev/docs/d3/7.8.5/classes/FormatSpecifier.html

Internally tsdocs.dev uses a customized version of typedoc to parse and render documentation, which works on docstrings and markdown https://typedoc.org/guides/doccomments/

Development

  1. Ensure that you have redis installed and running locally
  2. Run yarn install
  3. Run yarn dev

More Repositories

1

bundlephobia

πŸ‹οΈ Find out the cost of adding a new frontend dependency to your project
JavaScript
8,606
star
2

network-idle-callback

Like requestIdleCallback, but for detecting network idle
JavaScript
135
star
3

package-build-stats

This is the cloud function that powers the core of building, minifying and gzipping of packages in bundlephobia
JavaScript
91
star
4

covid-19-mobility-tracker

Google Mobility Reports, reverse-engineered into a JSON / CSV API
JavaScript
85
star
5

useragent-generator

Easily generate correct user-agent strings for popular browsers
JavaScript
66
star
6

curldiff

An interactive utility to compare differences between two curl requests in a human readable format
JavaScript
14
star
7

similar-npm-packages

Similar packages suggestions for the NPM ecosystem
TypeScript
8
star
8

google-analytics-logger-extension

Check if your Google analytics events are firing as they should using this convenient open-source logger.
JavaScript
7
star
9

mobx-promise

A tiny dependency-free library that makes working with promises in MobX easy.
JavaScript
6
star
10

throttle-queue

A promise based priority queue with task deduplication, concurrency control, serial resolution and aging
JavaScript
6
star
11

nnc

Visualisation for nearest neighbour chain algorithm
JavaScript
5
star
12

sort-class-members-codemod

A codemod for automatically fixing issues reported by eslint-plugin-sort-class-members
JavaScript
4
star
13

a-b-experiments

A presentation about the ABCs of A/B Experiments
JavaScript
3
star
14

developing-interactions

A presentation on developing delightful micro interactions on the web
JavaScript
2
star
15

ttc

Measure the time taken to compelete a flow from home page to the cart page.
JavaScript
2
star
16

parse-http-header

Parse values of request as well as response HTTP headers
JavaScript
2
star
17

awesome-ab-experiments

A curated list of resources about running A/B tests
2
star
18

a-k-apart

CSS
1
star
19

ud_portfolio

Level 0 App for Android Nanodegree which showcases portfolio of apps built in this excercise
Java
1
star
20

es6-webpack-presentation

ES6, Babel and Webpack
HTML
1
star
21

carpediem-archive

Archived website for the 2016 edition of IIMC's Carpe Diem fest
HTML
1
star
22

semver-closest

Find the closest matching semver from an array of semver versions
JavaScript
1
star
23

ccn

1
star
24

cloud9

HTML
1
star
25

kaldi-hugo-cms-template

CSS
1
star
26

merge-conflicts

HTML
1
star
27

renovate-range-strategy-repro

1
star
28

gatsby-starter-netlify-cms

JavaScript
1
star
29

RoadRunner

FYP
HTML
1
star
30

todos-test

JavaScript
1
star
31

MAD-Notes

1
star
32

playwright-bug-context-close

TypeScript
1
star
33

dust-loader-complete

A complete webpack loader for DustJS files.
JavaScript
1
star
34

marginauto

A blog about design and front end tips and tricks.
CSS
1
star
35

bitbucket-api-client

JavaScript
1
star
36

UD-MoviesApp

MOvies app P1 for udacity android nanodegree.
Java
1
star
37

bookmybook

HTML
1
star
38

Utsav_2015_new

Java
1
star