Skip to content

Latest commit

 

History

History
75 lines (42 loc) · 3.38 KB

README.md

File metadata and controls

75 lines (42 loc) · 3.38 KB
Raw

Bootstrap 3 RTL Theme

Note: Hopefully, they will add rtl support to the next major release of bootstrap, so this project will be absolete. However, it's going to be updated for the next 3.x releases.

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development.

Bootstrap RTL provides simple yet robust right-to-left capability for Bootstrap 3, by employing new theming feature of it. Simply put its CSS after bootstrap's original CSS, to the pages designed by Bootstrap 3. It works just like an extension on top of the original Bootstrap:

<!-- Original Bootstrap 3.x -->
<link rel="stylesheet" href="bootstrap.css">

<!-- Bootstrap RTL Theme -->
<link rel="stylesheet" href="bootstrap-rtl.css">

Or load it from CDN (3.2.0-rc2):

<!-- Load Bootstrap RTL theme from CDNJS -->
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/bootstrap-rtl/3.2.0-rc2/css/bootstrap-rtl.min.css">

Quick start

To get started, download latest release. Check examples/ directory for more. It's just like Bootstrap 3, nothing special. You can also install it via bower:

  • Run bower install bootstrap-rtl and latest version will be installed under bower_components/bootstrap-rtl/ directory.

In addition to bootstrap distribution, LESS codes for RTL theme and compiled CSS (bootstrap-rtl.css) are provided, as well as minified CSS (bootstrap-rtl.min.css). Check dist/ directory for all the codes you need.

Auto Flip (.flip)

To automatically flip placements from right to left and vice versa (in bilingual pages), use .flip alongside .pull-right and .pull-left. This is a custom class and is not available in the original Bootstrap 3.

Building CSS and JavaScript

Bootstrap RTL uses Grunt for working with the framework. Follow these simple steps to prepare and compile:

  1. Run npm install to download and prepare dependencies.
  2. Run grunt, and check dist/ directory for outputs.

Development

Contributors to Bootstrap RTL must agree the license by signing on the bottom of the CONTRIBUTORS.md file. To contribute:

  • fork the bootstrap-rtl repository.
  • make your changes
  • first time contributors: Sign CONTRIBUTORS.md by adding your github username, full name, email address, and first contribution date. As follows: YYYY/MM/DD, Github Username, Full Name, Email Address
  • commit your changes.
  • send a pull request.

Important Notice: Before submitting any pull request, please ensure that your changes merge cleanly with the main repository at morteza/bootstrap-rtl.

Feature requests, and bug fixes

If you want a feature or a bug fixed, report it via project's issues tracker. However, if it's something you can fix yourself, fork the project, do whatever it takes to resolve it, and finally submit a pull request. I will personally thank you, and add your name to the list of contributors.

Author

Morteza Ansarinia

License

I have no idea what licenses are for exactly. So there is no license control over this bootstrap-rtl project. However bootstrap itself is licensed by Twitter, Inc. under the MIT License (MIT).