Skip to content
This repository has been archived by the owner on Jan 14, 2020. It is now read-only.
/ offline-docs Public archive

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

Notifications You must be signed in to change notification settings

vvo/offline-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

offline-docs Dependency Status devDependency Status

screenshot

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 git@github.com:vvo/offline-docs.git
cd offline-docs
npm run dev

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

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published