vvo / offline-docs

Always get some documentation on the modules you use, even offline

offline-docs

Always get some documentation on the modules you use, even offline.

No network no work? WRONG! Get the minimum documentation when you need it.

npm install -g offline-docs
cd awesomeNodeJSProject
offline-docs
# Offline docs server listening on http://0.0.0.0:5000

Now go to http://0.0.0.0:5000 to see offline docs.

This module may also be usefull in situations where you do have network. It shows all you module dependencies and documentation on a simple page.

contribute

git clone [email protected]:vvo/offline-docs.git
cd offline-docs
npm run dev

Now go to http://localhost:3000, edit the files, it reloads automatically and PR!

offline-docs's Issues

The package is not working for me.

My steps:

~ $ npm install -g offline-docs
~ $ git clone https://github.com/airbnb/enzyme.git
~ $ cd enzyme
enzyme $ offline-docs

Then I have opened http://0.0.0.0:5000/ and that's all - I have ERR_ADDRESS_INVALID error.
I have tryied that on the Linux and Windows machines. :)

Maybe the package don't finished and I don't know about it?

The best regards, Pavel Tretyakov.

Doesn't work on my project

"devDependencies": {
    "chai": "^1.9.1",
    "chai-as-promised": "^4.1.1",
    "chai-jquery": "^1.2.1",
    "express": "^4.7.2",
    "faker": "^1.1.0",
    "grunt": "^0.4.5",
    "grunt-cli": "~0.1.11",
    "grunt-concurrent": "^0.5.0",
    "grunt-contrib-clean": "~0.4.0",
    "grunt-contrib-concat": "^0.5.0",
    "grunt-contrib-copy": "~0.4.0",
    "grunt-contrib-cssmin": "^0.10.0",
    "grunt-contrib-sass": "^0.8.1",
    "grunt-contrib-uglify": "~0.2.2",
    "grunt-contrib-watch": "^0.6.1",
    "grunt-filerev": "^0.2.1",
    "grunt-karma": "^0.8.3",
    "grunt-ng-annotate": "^0.3.2",
    "grunt-ng-constant": "^1.0.0",
    "grunt-usemin": "^2.3.0",
    "ip": "^0.3.0",
    "js-yaml": "^3.2.1",
    "karma": "^0.12.16",
    "karma-chrome-launcher": "^0.1.3",
    "karma-mocha": "^0.1.3",
    "karma-ng-html2js-preprocessor": "^0.1.0",
    "karma-phantomjs-launcher": "^0.1.4",
    "karma-webdriver-launcher": "^0.2.0",
    "load-grunt-tasks": "^0.6.0",
    "lodash": "^2.4.1",
    "mocha": "^1.21.4",
    "protractor": "^0.24.2",
    "sinon": "^1.10.3",
    "sinon-chai": "^2.5.0"
  }

'/node_modules' is not recognized as an internal or external command

I'm having trouble with this one... somebody please help... thanks:

$ npm run dev

[email protected] dev D:\programming\web development\offline-docs
npm run server-watch & npm run watch-js & npm run browser-sync

[email protected] server-watch D:\programming\web development\offline-docs
watchy -kw app.js -i '/.|/node_modules|/test$' -- offline-docs

'/node_modules' is not recognized as an internal or external command,
operable program or batch file.
npm ERR! code ELIFECYCLE
npm ERR! errno 255
npm ERR! [email protected] server-watch: watchy -kw app.js -i '/\.|/node_modules|/test$' -- offline-docs
npm ERR! Exit status 255
npm ERR!
npm ERR! Failed at the [email protected] server-watch script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\Nelszy\AppData\Roaming\npm-cache_logs\2018-02-25T03_40_15_691Z-debug.log

[email protected] watch-js D:\programming\web development\offline-docs
watchify browser.js -o site/bundle.js -dv

path.js:28
throw new TypeError('Path must be a string. Received ' + inspect(path));
^

TypeError: Path must be a string. Received undefined
at assertPath (path.js:28:11)
at Object.dirname (path.js:725:5)
at Deps.lookupPackage (D:\programming\web development\offline-docs\node_modules\module-deps\index.js:452:29)
at Deps._transform (D:\programming\web development\offline-docs\node_modules\module-deps\index.js:93:10)
at Deps.Transform._read (D:\programming\web development\offline-docs\node_modules\readable-stream\lib_stream_trans form.js:184:10)
at Deps.Transform._write (D:\programming\web development\offline-docs\node_modules\readable-stream\lib_stream_tran sform.js:172:12)
at Labeled.Pipeline._write (D:\programming\web development\offline-docs\node_modules\stream-splicer\index.js:73:22)
at doWrite (D:\programming\web development\offline-docs\node_modules\readable-stream\lib_stream_writable.js:279:12 )
at writeOrBuffer (D:\programming\web development\offline-docs\node_modules\readable-stream\lib_stream_writable.js: 266:5)
at Labeled.Writable.write (D:\programming\web development\offline-docs\node_modules\readable-stream\lib_stream_wri table.js:211:11)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] watch-js: watchify browser.js -o site/bundle.js -dv
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] watch-js script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\Nelszy\AppData\Roaming\npm-cache_logs\2018-02-25T03_40_19_113Z-debug.log

[email protected] browser-sync D:\programming\web development\offline-docs
browser-sync start --proxy 'localhost:5000' --files 'site/**' --no-open

[Browsersync] Proxying: http://
[Browsersync] Access URLs:

   Local: http://localhost:3000/%27localhost:5000%27
External: http://192.168.1.5:3000/%27localhost:5000%27

---

      UI: http://localhost:3001

UI External: http://192.168.1.5:3001

[Browsersync] Watching files...