rBootstrap is the RTL version of Twitter Bootstrap.
To get started, check out http://rbootstrap.ir!
Three quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/jnaqsh/rbootstrap.git.
- Install with Bower:
bower install rbootstrap.
Read the Getting Started page for information on the framework contents, templates and examples, and more.
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
bootstrap/ ├── css/ │ ├── bootstrap.css │ ├── bootstrap.min.css │ ├── bootstrap-theme.css │ └── bootstrap-theme.min.css ├── js/ │ ├── bootstrap.js │ └── bootstrap.min.js └── fonts/ ├── glyphicons-halflings-regular.eot ├── glyphicons-halflings-regular.svg ├── glyphicons-halflings-regular.ttf └── glyphicons-halflings-regular.woff
We provide compiled CSS and JS (
bootstrap.*), as well as compiled and minified CSS and JS (
bootstrap.min.*). Fonts from Glyphicons are included, as is the optional Bootstrap theme.
Bugs and feature requests
Have a bug or a feature request? Please open a new issue.
Running documentation locally
- If necessary, install Jekyll (requires v1.x).
- Windows users: read this unofficial guide to get Jekyll up and running without problems.
- From the root
jekyll servein the command line.
- Windows users: For Ruby 2.0.0 run
chcp 65001first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors. For Ruby 1.9.3 you can alternatively do
SET LANG=en_EN.UTF-8. In addition, ensure you have Python installed and added in your
PATHor the build will fail due to our Pygments dependency.
- Windows users: For Ruby 2.0.0 run
- Open http://localhost:9001 in your browser, and voilà.
Learn more about using Jekyll by reading its documentation.
Documentation for previous releases
Documentation for v2.3.2 has been made available for the time being at http://rbootstrap.ir/2.3.2/ while folks transition to Bootstrap 3.
Previous releases and their documentation are also available for download.
Bootstrap uses Grunt with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.
From the command line:
npm install -g grunt-cli.
- Navigate to the root
/bootstrapdirectory, then run
npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.
When completed, you'll be able to run the various Grunt commands provided from the command line.
npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.
Available Grunt commands
This is a convenience method for watching just Less files and automatically building them whenever you save.
Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun
For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
And constructed with the following guidelines:
- Breaking backward compatibility bumps the major (and resets the minor and patch)
- New additions without breaking backward compatibility bumps the minor (and resets the patch)
- Bug fixes and misc changes bumps the patch
For more information on SemVer, please visit http://semver.org/.