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

@viveknigam3003/quickdocs

v0.1.9

Published

The fastest way to generate good documentation for your JavaScript and Typescript projects. Super simple to use, just run `npx quickdocs` in your project's root directory and you're done! ๐Ÿš€

Downloads

58

Readme

Quickdocs โšก๏ธ๐Ÿ“„

The fastest way to generate good documentation for your JavaScript and Typescript projects. Super simple to use, just run npx quickdocs in your project's root directory and you're done! ๐Ÿš€

Features

  • Generates documentation for your entire project in seconds
  • Supports JavaScript and Typescript
  • Minimal configuration required (just a quickdocs.config.json file)
  • Returns a folder with HTML files which can be hosted on any static file server

The generated documentation is based on the TypeDoc project.

Installation

npm i -D @viveknigam3003/quickdocs

Usage

Run the following command in your project's root directory. It will generate a docs folder with the documentation for your project.

npx quickdocs

Configuration

Create a quickdocs.config.json file in your project's root directory. Configuration options are the same as those for TypeDoc.

Here's an example configuration. You can use the $schema property to get intellisense support in your editor, but it's not mandatory.

{
	"$schema": "https://typedoc.org/schema.json",
	"tsconfig": "./tsconfig.json",
	"entryPoints": ["./src/modules/index.ts"],
	"out": "./docs",
	"name": "My project docs",
}

How it works?

Quickdocs extracts out the documentation of your project starting from the entryPoints specified in the quickdocs.config.json file. It then generates a docs folder with the documentation for your project.

This docs folder contains static HTML files for each of the functions, classes, types, etc. in your project. You can host this folder on any static file server to make the documentation available to others. You can customize the out property in the quickdocs.config.json file to change the output directory.

License

MIT

Author

Vivek Nigam

Contributing

Contributions are welcome! Feel free to open an issue or a pull request.

References

Theme inspired by tsdocs.dev