Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including manu with all npm packages installed. Try it out:

manu lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("manu/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

manu v1.5.2

Read devdocs.io docs from your cozy terminal

npm version Dependency Status

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

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free