search

envato-archive / guide

Document your application with a living component library and styleguide
https://rubygems.org/gems/guide
MIT License
8 stars 3 forks source link

Add basic installation and config instuctions #51

Closed jordanlewiz closed 8 years ago

jordanlewiz commented 8 years ago

These instructions are very primitive but the main goal is trying to organise the structure for the instructions.

This readme will be an evolving document, but this is a starting point. Please feel free to update instructions and examples as you notice they are wrong, missing or out-of-date.

lukearndt commented 8 years ago

:100:

jordanlewiz commented 8 years ago

@lukearndt how does one go about changing the route of a Guide?

We have a whole different domain, but say we had just http://envato.com what would the URL be?

lukearndt commented 8 years ago

When you mount the gem in your routes file, you can specify a route to mount it to. If you want it mounted at the root of your application, you'd use:

mount Guide::Engine => "/"

Or if you want it at, say, /guide/, you could use:

mount Guide::Engine => '/guide/'

Any routes defined by the Guide gem will be prefixed with the path you specify when you mount it.