search

mtmacdonald / docgen

A documentation tool
http://mtmacdonald.github.io/docgen
Other
44 stars 15 forks source link

installation is not working correctly on windows #bug #106

Open EliaOndacs opened 3 months ago

EliaOndacs commented 3 months ago

hello, i tried downloading docgen using the nom command npm install -g docgen-tool it said it downloaded but when i try to run the docgen it fails saying it cannot find an executable with the name docgen

if any help i appreciate it , i filed i issue here cause i think the installation process failed

mtmacdonald commented 3 months ago

Thanks, could be a PATH issue on Windows? I don't have a Windows machine to test on right now, but I'll check it when I can.

Amirsouissi commented 2 weeks ago

1- Create a batch file: -Open Notepad -Paste the following content:

@echo off
node C:\Users\YourUsername\AppData\Roaming\npm\node_modules\docgen-tool\dist\src\docgen.js %*

2- Save this file as docgen.cmd in C:\Users\YourUsername\AppData\Roaming\npm

3- Add to PATH: Now, let's add C:\Users\YourUsername\AppData\Roaming\npm to your PATH if it's not already there: Press Win + X and select "System" Click on "Advanced system settings" on the right Click on "Environment Variables" near the bottom of the window Under "System variables", find and select "Path", then click "Edit" Click "New" and add C:\Users\YourUsername\AppData\Roaming\npm Click "OK" on all windows to save changes 💯 ✌️