https://github.com/pastelsky/tsdocs

Browse type documentation for JS libraries
https://github.com/pastelsky/tsdocs

api-ref documentation typescript

Last synced: about 1 month ago
JSON representation

Browse type documentation for JS libraries

• Host: GitHub
• URL: https://github.com/pastelsky/tsdocs
• Owner: pastelsky
• License: mit
• Created: 2023-11-01T18:35:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-23T09:40:34.000Z (5 months ago)
• Last Synced: 2024-09-26T22:20:15.730Z (about 2 months ago)
• Topics: api-ref, documentation, typescript
• Language: TypeScript
• Homepage: https://tsdocs.dev
• Size: 3.99 MB
• Stars: 1,115
• Watchers: 6
• Forks: 25
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# tsdocs.dev







[TSDocs.dev](https://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](https://github.com/TypeStrong/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](https://github.com/DefinitelyTyped/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](https://redis.io/docs/install/install-redis/) and running locally

2. Run `yarn install`

3. Run `yarn dev`

## Sponsors