0
0
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
2013-07-26 22:27:55 +08:00
_includes Bump version of old docs in callout 2013-07-25 21:52:21 -07:00
_layouts Mo betta placement of old docs callouts 2013-07-26 01:43:43 -07:00
assets Mo betta placement of old docs callouts 2013-07-26 01:43:43 -07:00
dist fix background of btn-link 2013-07-26 22:27:55 +08:00
js Replace Makefile with GruntJS 2013-07-26 00:39:14 -07:00
less fix background of btn-link 2013-07-26 22:27:55 +08:00
_config.yml undo change to config exclude 2013-07-20 00:07:04 -07:00
.editorconfig Use* global rules with exceptions as needed 2013-04-22 17:10:59 +10:00
.gitignore finish flattening repo structure; add dist folder of compiled css/js 2013-07-18 18:14:49 -07:00
.travis.yml Replace Makefile with GruntJS 2013-07-26 00:39:14 -07:00
bower.json ignore .files for bower packaging 2013-07-19 13:23:17 -05:00
components.html Fix up navbar forms 2013-07-25 23:32:12 -07:00
composer.json twbs ALL the links 2013-07-25 12:24:13 -07:00
CONTRIBUTING.md twbs ALL the links 2013-07-25 12:24:13 -07:00
css.html Fixes #8586: add addional color text classes to apply all of branch colors easily 2013-07-26 00:18:18 -07:00
customize.html Disable the customizer for rc1 for now 2013-07-25 23:29:43 -07:00
getting-started.html twbs ALL the links 2013-07-25 12:24:13 -07:00
Gruntfile.js re-integrate #8560 using @fat's code from the comment on #8614 2013-07-26 01:15:41 -07:00
index.html Mo betta placement of old docs callouts 2013-07-26 01:43:43 -07:00
javascript.html update docs a bit more for affix 2013-07-25 23:57:21 -07:00
LICENSE 'root' repo end 'insert_final_newline = true' 2013-04-22 17:19:56 +10:00
package.json Replace Makefile with GruntJS 2013-07-26 00:39:14 -07:00
README.md readme /cc @zdroid 2013-07-26 01:46:30 -07:00

Bootstrap v3.0.0 Build Status

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:

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 root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://getbootstrap.com. The docs may also be run locally.

Running documentation locally

  1. If necessary, install Jekyll (requires v1.x).
  2. From the /bootstrap directory, run jekyll serve in the command line.
  3. 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.

Previous releases and their documentation are also available for download.

Compiling CSS and JavaScript

Bootstrap uses GruntJS with convenient methods for working with the framework. Before getting started, be sure to have grunt-cli installed globally (npm install -g grunt-cli) and then install the necessary local dependencies:

# if grunt-cli isn't already installed
$ npm install -g grunt-cli

$ npm install

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

Unfamiliar with 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

Build - grunt

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

Compile CSS, and JavaScript - grunt bootstrap

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

Tests - grunt test

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

Watch - grunt watch

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

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running grunt 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.

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

Copyright 2012 Twitter, Inc under the Apache 2.0 license.