grahamar/giles repository overview

⁠Giles The Librarian

Pronounced 'Jy-ils'

⁠Who Is Giles?

Giles loves documentation, he'll look after your documentation for you. Keep it versioned and in an orderly fashion. In other words, Giles is a simple documentation repository app, strongly influenced by the awesome project readthedocs.org⁠.

Writing documentation is not an easy task, Giles knows this, but lucky for you, Giles loves documentation! So he wants to make the rest of the process as easy as possible for you. Giles can pull from your Git repository, and scour every tagged version as well as the HEAD, for documentation (Giles only reads markdown at the moment...), store it in a Mongo database and index it for your perusal.

⁠Getting To Know Giles

Check out the complete [Getting Started Guide](docs/Getting Started.md).

⁠Running Giles

There's manual steps in the Getting started documentation. Or you can install Docker⁠ and pull the latest image⁠

⁠Copyright and license

Copyright 2013 Gilt Groupe, Inc., under the Apache v2.0⁠ license