PrettyDocs Rails

A rails plugin for the PrettyDocs Bootstrap theme.

Dependencies

This is has been tested on the following:

Other dependencies:

Add this line to your application's Gemfile:

# PrettyDocs Rails
gem 'prettydocs_rails'

How to use this plugin.

Change your application.css to application.scss.

$ mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss

Then, remove all the *= require_self and *= require_tree . statements from the sass file. Instead, use @import to import Sass files.

Do not use *= require in Sass or your other stylesheets will not be [able to access][antirequire] the Bootstrap mixins or variables.

Using SCSS, add this to your application.scss file:

@import "prettydocs";

Add the following line to your application.js file:

//= require prettydocs

A live demo of PrettyDocs is available at http://themes.3rdwavemedia.com/demo/prettydocs/index.html. To view example pages, download the original files.

PrettyDocs is made by UX designer Xiaoying Riley for developers and is 100% FREE under the Creative Commons Attribution 3.0 License (CC BY 3.0).

PrettyDocs on Github.

The gem is available as open source under the terms of the Creative Commons Attribution 3.0 License (CC BY 3.0).