npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

docs-typescript

v0.1.7

Published

Tool for documenting Typescript based projects

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

fedynafedyna

Keywords

documentationdocumentation-generatortypescript

Readme

Docs Typescript - Documenting Typescript made easy

Tool for documenting Typescript APIs using API Extractor Model with support for Markdown, Docusaurus (WIP) and HTML (WIP). Alternative to api-documenter and TypeDoc with better UX, much richer API presentation and support for single and multi page documentation.

Getting Started

Create configuration

  • Creates docs.config.json, api-extractor.json and tsdoc.json files with default values
npx docs-typescript init

Extract API Model from declaration files

  • Defaults to types/index.d.ts file
npx docs-typescript extract

Build documentation form API Model

  • Defaults to api.json file, creates docs folder with documentation
npx docs-typescript build

Documentation

For all the details see DocsTypescript.com, for API documentation see DocsTypescript.com/api (Work in Progress)

Examples

Supported TSDoc tags

  • @remarks
  • @example
  • @type
  • @typeParam
  • @returns
  • @info
  • @alert
  • @error
  • @author
  • @since
  • @public
  • @beta
  • @alpha
  • @internal
  • @deprecated

For more informations visit Doc comment syntax

Roadmap

  • [ ] Markdown support
  • [ ] Single page / Multi page
  • [ ] Project website
  • [ ] Support for @link tag
  • [ ] React support (categories for components/hooks/providers)
  • [ ] Mermaid support to present inheritance and dependencies
  • [ ] Create and use api-extractor alternative in form of extractor-typescript
  • [ ] Docusaurus (MDX) output support
  • [ ] HTML output support