marborkowski / react-doc-generator

Generate a simple React component documentation in Markdown.
MIT License
55 stars 30 forks source link

not working out of the box (Win10) #3

Closed j2l closed 3 years ago

j2l commented 7 years ago

npm install -save-dev react-doc-generator

capokey@0.0.0 E:\capokey
`-- react-doc-generator@1.2.5
  +-- cli-table@0.3.1
  | `-- colors@1.0.3
  +-- colors@1.1.2
  +-- commander@2.9.0
  | `-- graceful-readlink@1.0.1
  +-- handlebars@4.0.10
  | +-- async@1.5.2
  | `-- source-map@0.4.4
  |   `-- amdefine@1.0.1
  +-- node-dir@0.1.17
  +-- react-docgen@2.17.0
  | +-- babylon@5.8.38
  | +-- node-dir@0.1.17  deduped
  | `-- recast@0.12.6
  |   `-- ast-types@0.9.11
  `-- react-dom@15.6.1

then: npm run react-doc-generator src -o DOCUMENTATION.md

npm ERR! missing script: react-doc-generator

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\pm\AppData\Roaming\npm-cache\_logs\2017-09-05T10_27_38_117Z-debug.log
joshdhenry commented 7 years ago

+1 Same issue here on Mac OS X. Solution for me was to add the -g flag to npm install command.

j2l commented 7 years ago

With -g, it still doesn't work for me on Win10

marcochiang commented 6 years ago

Yeah the only thing that worked for me is going into the node_module of react-doc-generator itself and running react-doc-generator {src} -o "DOC".md and i'm on the latest macOS

nelmarianna commented 6 years ago

Had the same issue then I installed the module with -g and it worked as expected

antoniojps commented 5 years ago

Try running react-doc-generator with

npm run react-doc-generator

or

yarn react-doc-generator

If this doesnt work, there's a dirty solution, add:

"react-doc-generator": "node_modules/react-doc-generator/dist/react-doc-generator.js"

to your scrips in the package.json file.

CezaryDanielNowak commented 3 years ago

https://github.com/CezaryDanielNowak/react-doc-generator Please checkout this, works on Windows and has several improvements.

j2l commented 3 years ago

Thanks. Meanwhile I switched to svelte.