sjoerdbeentjes / pkg-docs

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

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


Languages

Language:JavaScript 68.8%Language:CSS 17.4%Language:EJS 13.9%