Git Product home page Git Product logo

tsdocs's Introduction

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

tsdocs's People

Contributors

pastelsky avatar yash-singh1 avatar itp2023 avatar rvbsm avatar dependabot[bot] avatar reala10n avatar benjaminismyname avatar takagimeow avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.