manu
v1.5.2
Published
Read devdocs.io docs from your cozy terminal
Downloads
6
Readme
manu
Read devdocs.io content from your cozy terminal.
mad is a nice tool to view docs written in markdown like regular man
pages.
Unfortunately it provides only outdated content by default.
manu
is a tool that queries the devdocs.io database to retrieve fresh data which can then be used by mad
.
Example
Let's say you want to grab the ramda docs:
manu fetch ramda
This will download the content of devdocs.io to ~/.manu-pages/json/ramda.json
manu convert ramda
This will convert the previously fetched JSON file to ~/.manu-pages/md/ramda.md
mad ramda
Et voilà !
Even better:
manu extract ramda
HTML files have now been extracted to ~/.manu-pages/html/ramda/
You can browse them and follow internal links smoothly.
lynx ~/.manu-pages/html/ramda/index.html
Hints:
- You can do all the operations in one go using
manu pull ramda
- You can target a specific version of docs if available
manu pull angular-1.5
Install
Install mad, then:
npm i -g manu
Add this variable to your shell:
export MAD_PATH=~/.manu-pages/md
Usage
List fetched (JSON), converted (MD) and extracted (HTML) docs:
manu ls
List all local and available docs
manu ls -a
Pull = fetch + convert + extract :
manu pull <doc>
Download JSON raw data from devdocs.io to local cache:
manu fetch <doc>
Convert raw JSON to markdown:
manu convert <doc>
Extract HTML files from the raw JSON
manu extract <doc>
Remove local files
manu rm <doc>
License
ISC