mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00

The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web. http://getbootstrap.com

Go to file

Mark Otto 296b9d7293 Merge pull request #8313 from jholl/patch-1 typo: match doc text and example		2013-06-26 11:42:04 -07:00
docs	Merge pull request #8313 from jholl/patch-1	2013-06-26 11:42:04 -07:00
fonts	removing glyphicons images, swapping in new icon font with new classes	2012-11-02 01:20:06 -07:00
js	Fixes #7730 : Better hiding of empty titles in popovers	2013-06-20 16:02:05 -07:00
less	Merge pull request #8301 from cvrebert/patch-3	2013-06-25 17:11:31 -07:00
_config.yml	Back to getbootstrap.dev for jekyll	2013-05-20 10:45:01 -07:00
.editorconfig	Use* global rules with exceptions as needed	2013-04-22 17:10:59 +10:00
.gitignore	nuke that docs _site folder	2013-05-16 13:46:12 -07:00
.travis.yml	'root' repo end 'insert_final_newline = true'	2013-04-22 17:19:56 +10:00
bower.json	Rename component.json to bower.json	2013-06-01 22:59:13 +02:00
CHANGELOG.md	a bunch javascript junk	2013-05-16 11:06:30 -07:00
composer.json	fix JSON syntax error in composer.json	2013-06-10 14:59:42 +02:00
CONTRIBUTING.md	Update contributing file	2013-05-20 00:33:08 -07:00
LICENSE	'root' repo end 'insert_final_newline = true'	2013-04-22 17:19:56 +10:00
Makefile	remove make gh-pages command	2013-05-21 19:56:25 -07:00
package.json	change version of recess to 1.1.7	2013-06-13 19:27:26 +08:00
README.md	Add note about Jekyll version per #8195	2013-06-17 21:36:03 -07:00

README.md

Bootstrap v3.0.0

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by Mark Otto and Jacob Thornton.

To get started, check out http://getbootstrap.com!

Quick start

Three quick start options are available:

Download the latest release.
Clone the repo: git clone git://github.com/twitter/bootstrap.git.
Install with Bower: bower install bootstrap.

Read the Getting Started page for information on the framework contents, templates and examples, and more.

Bugs and feature requests

Have a bug or a feature request? Please open a new issue. Before opening any issue, please search for existing issues and read the Issue Guidelines, written by Nicolas Gallagher.

Documentation

Bootstrap's documentation, included in this repo in the /docs directory, is built with Jekyll and publicly hosted on GitHub Pages at http://getbootstrap.com. The docs maybe also be run locally.

Running documentation locally

If necessary, install Jekyll (requires v1.x).
From the /bootstrap directory, run jekyll serve in the command line.
Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading their documentation.

Documentation for previous releases

Documentation for v2.3.2 has been made available for the time being at http://getbootstrap.com/2.3.2/docs while folks transition to Bootstrap 3.

For previous releases, documentation is available for download via Git tags.

Compiling CSS and JavaScript

Bootstrap includes a makefile with convenient methods for working with the framework. Before getting started, install the necessary local dependencies:

$ npm install

When completed, you'll be able to run the various make commands provided.

Available makefile commands

Build - `make`

make runs the Recess compiler to rebuild the /less files and compile the docs. Requires recess and uglify-js.

Compile CSS, JS, and fonts - `make bootstrap`

make bootstrap creates the /bootstrap directory with compiled files. Requires recess and uglify-js.

Tests - `make test`

Runs jshint and qunit tests headlessly in phantomjs (used for ci). Requires phantomjs.

Watch - `make watch`

This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the watchr gem.

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running makefile commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Contributing

Please read through our guidelines for contributing to Bootstrap. Included are directions for opening issues, coding standards, and notes on development.

More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Community

Keep track of development and community news.

Follow @twbootstrap on Twitter.
Read and subscribe to the The Official Twitter Bootstrap Blog.
Have a question that's not a feature request or bug report? Ask on the mailing list.
Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##twitter-bootstrap channel.

Versioning

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:

<major>.<minor>.<patch>

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

Authors

Mark Otto

Jacob Thornton