Skip to main content

​
No Installation Required!

You can use mint-tsdocs without installing it: 
npx mint-tsdocs
That’s it! All dependencies are bundled.

​
Optional: Install Locally

Want faster execution or version locking? 
npm install -D mint-tsdocs

​
Or Globally

npm install -g mint-tsdocs
Then run without npx: 
mint-tsdocs
Benefits:
  • Faster execution (no download)
  • Version pinned in package.json
  • Works offline
  • Slightly cleaner npm scripts
Downsides:
  • Adds to node_modules size
  • Need to update manually
Benefits:
  • Always latest version
  • No node_modules bloat
  • Works in any project instantly
  • No installation step
Downsides:
  • First run downloads (cached after)
  • Requires internet connection

​
Requirements

  • Node.js 18 or higher
  • TypeScript project with declaration: true in tsconfig.json

​
Next Steps

Quick Start

Generate your first documentation