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

docsify-tools

v1.0.20

Published

Quickly document your (typescript or otherwise) projects!

Downloads

26,432

Readme

docsify-tools

Quickly document your (typescript or otherwise) projects!

  • docsify-init provides a client-side Docsify based markdown documentation site with full text search
  • generate-ts-doc generates markdown documentation from api-extractor api.json files
  • docsify-auto-sidebar automatically populates the sidebar from the resulting docs tree

docsify-init

Usage:

docsify-init [-r repoDir] [-d docsDir]

Initializes docsify in the specified repo and docs sub-directory. By default, the repo is the current directory and the subdirectory is "docs".

You can use docsify-init -r . -d . to initialize in a pure-documentation repo.

docsify-auto-sidebar

Usage:

docsify-auto-sidebar -d docs

Generates a new _sidebar.md for docsify. You can prefix directories with a number and a dash to control the ordering, the number and dash will not appear in the sidebar text. For example:

1-Guides
2-API

will result with "Guides" and "API" items in the sidebar.

Other dashes will be replaced with spaces

generate-ts-doc

Like api-documenter, but it doesn't generate separate files for methods or properties. Create the .api.json files in a directory (e.g. in docs/2-API) and then run it:

generate-ts-doc markdown -i docs/2-API -o docs/2-API

Notes

Don't forget to setup your repo so that github generates a documentation site