• npm: npm install gman -g

G-Man is a documentation engine which uses GitHub.com as the doc source, and parses Markdown documents to provide an easy way for developers to read documentation. All of the options in G-Man can be configured with the .gman.yml configuration.

Source: ViaEstelar on DeviantArt.com.

G-Man follows a format that allows a readable format in both GitHub and the CLI. By following the standards your output will look something similar to the following

Please follow the example for the G-Man documentation in creating your own documentation files.

When the developer types gman in the root of your application, G-Man will cleverly find all of your documentation files and enumerate them to the developer. Developers can also perform searches on your G-Man documentation – all from the command prompt, and without you having to do anything special!

As a developer you're likely to want information on a given method. Using G-Man you can locate the documentation for a function by specifying the gman -f methodName command – where methodName is the function you would like further information about. G-Man will iterate over the documentation to discover the files which contain your desired method – if only one file has the method then that is output, otherwise you'll be given a choice.

Using the .gman.yaml file you can modify default G-Man parameters.

Currently G-Man supports the directory property which you can modify to alter the documentation location.

Configuration parameters are specified in the traditional YAML way:

directory: documentation