{{ inherits('layouts/fluid') -}}

GitHub Documentation

GitHub Documentation provides automated and customisable documentation for GitHub. You choose what colour coding is used for syntax highlighting and your setting is remembered. You choose what style of docs you want and your setting is remembered.

To use, simply navigate to http://www.gitdocs.co.uk/{user}/{repo}

About

GitHub Documentation provides automated and customisable documentation for GitHub. You choose what colour coding is used for syntax highlighting and your setting is remembered. You choose what style of docs you want and your setting is remembered.

To use, simply navigate to http://www.gitdocs.co.uk/{user}/{repo}

Featured Users and Repositories

GitHub Documentation

Of course it's to be expected that the documentation of a project designed to provide documentation will be good :)

You can find our documentation here.

Azure SDK for Node

This library inspired me to write this application. It has awful documentation (although it is steadily improving)

However, the source code is very well documented, so if you browse it on here it looks great.

Express

If you're using node.js you really should be using express. It has simply the best framework for building web-servers. I love how unopinionated the design is, anything that causes debate becomes a separate module, so you can choose.

As with all of visionmedia's projects, it has excelent documentation.

Dox

This is one of the libraries that this application is built off. It's responsible for parsing source code into a JSON structure that can be rendered as documentation.

Of course, being all about documentation, it works great if you browse it on GitHub Docs.

QEJS

This is another library that this application is built off. It's responsible for combining the output of parsers like dox and a special template file to produce a web page.

It has a beautifully simple API for dealing with asyncronous operations within a template, which is why we use it here.

JEPSO

JEPSO is the company who produced this product, feel free to check out our other stuff.

GitHub Documentation will remain free for use with public projects, forever.