UNDER DEVELOPMENT

PrettyDocs Rails

A rails plugin for the PrettyDocs Bootstrap theme.

Dependencies

This is has been tested on the following:

• Ruby 2.3.3
• Rails 5.0.0.1

Other dependencies:

• Bootstrap Sass
• Font-Awesome Rails
• NOT INCLUDED: Elegant Icon Font is not currently included.

Installation

Add this line to your application's Gemfile:

gem 'bootstrap-sass', '~> 3.3.6'
# gem 'sass-rails', '>= 3.2' # uncomment if needed
gem "font-awesome-rails"
# PrettyDocs Rails
gem 'prettydocs-rails'

Usage

How to use this plugin.

Sass

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 "bootstrap-sprockets";
@import "bootstrap";
@import "font-awesome";
@import "prettydocs";
@import "prism";
@import "ekko-lightbox";

JavaScript

Add the following line to your application.js file:

//= require bootstrap-sprockets
//= require prettydocs
//= require ekko-lightbox
//= require prism
//= require jquery-match-height/jquery.matchHeight
//= require jquery-scrollTo/jquery.scrollTo

Demo

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

Contributing

• Michael Price

Features

• Fully Responsive
• HTML5 + CSS3
• Built on Bootstrap 3
• 6 Colour Schemes
• 600+ FontAwesome icons
• LESS files included
• Compatible with all modern browsers

PrettyDocs Credits

• Xiaoying Riley
• 3rd Wave Media
• Bootstrap
• FontAwesome
• Elegant icon font
• Google Fonts
• jQuery
• Prism
• Bootstrap Lightbox
• jQuery ScrollTo
• jQuery Match Height

License

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).

Copyright 2016 NewsDesk Ninja, Inc.