Generate markdown docs for your project's public API.
npx docs-md --help
Description
Generates documentation in markdown for your project
Usage
$ docs-md <barrelsGlob> [options]
Options
-o, --output Api docs directory (comma seperated) (default ./docs/api)
-v, --version Displays current version
-h, --help Displays this message
Examples
$ docs-md docs-md "./src/index.ts"
$ docs-md docs-md "./src/project1/index.ts,./src/project2/index.ts"
$ docs-md docs-md "./src/**/index.ts"
FAQs
docs-md
The npm package docs-md receives a total of 2 weekly downloads. As such, docs-md popularity was classified as not popular.
We found that docs-md demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."