/pkg-docs

Spins up a web app which bundles all the readme's of your dependencies

Primary LanguageJavaScript

pkg docs

Bundles all your readme's into a single web app. It fetches the readme's of the packages in your projects, and transforms them into a GitHub style readable format.

Screenshot

Usage

When in the directory of your project run:

npx pkg-docs

Options

option description default
--port Specific port to run on Available port between 5000 and 6000