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

ts-readme-generator

v0.7.4

Published

Small tool to automatically generate your API documentation straight into your `readme.md` from your TypeScript typings.

Downloads

286

Vulnerabilities

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

Links

Git

Maintainers

linusulinusu

Keywords

Readme

Generate Readme from TypeScript

Small tool to automatically generate your API documentation straight into your readme.md from your TypeScript typings.

Note: This is very much a work in progress. I'm currently going through my projects one by one and replacing the API docs with generated ones, improving this module as I go. Don't expect it to work with most modules just yet.

Installation

npm install --global ts-readme-generator

Usage

Make sure that your readme.md contains a ## API section (or ## Props if it's a React module), then simply run the command to update your Readme file from the TypeScript definitions.

ts-readme-generator

You can also run the script in "check mode" to make it exit with a non-zero status if the documentation isn't up to date.

ts-readme-generator --check

Examples

Check out these projects using ts-readme-generator:

If you are using this in a public project, please send a PR to add it to this list!