Skip to content

Commit

Permalink
Merge pull request #8 from pastelsky/pastelsky-patch-1-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
pastelsky authored Dec 19, 2023
2 parents 1ac8700 + eb9a97f commit f65559b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@ 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 running locally
Expand Down

0 comments on commit f65559b

Please sign in to comment.