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

vsn4ik d73d79a7a0 Use "@if not $bool" selector		2015-09-13 16:02:58 +03:00
dist	grunt	2015-09-06 09:36:24 -07:00
docs	Adds current version to packages.	2015-09-11 14:15:31 -05:00
grunt	grunt/configBridge.json: Remove unused autoprefixer config.	2015-08-30 00:05:02 +03:00
js	Run `grunt`.	2015-09-05 08:13:43 +03:00
scss	Use "@if not $bool" selector	2015-09-13 16:02:58 +03:00
test-infra	Remove the now unused test-infra files.	2015-09-08 07:14:14 +03:00
_config.yml	Use jekyll-sitemap instead of our custom solution.	2015-09-08 08:18:52 +03:00
.editorconfig	Update README.md.	2015-07-26 00:29:29 +03:00
.gitattributes	Remove dropped v3 bootstrap-theme	2015-09-08 08:58:03 +03:00
.gitignore	Add `vendor/bundle` to gitignore	2015-09-10 15:20:36 +10:00
.travis.yml	rm Travis env vars used for defunct custom caching system	2015-09-09 22:48:29 -07:00
bower.json	Merge branch 'master' into v4m	2015-08-04 22:29:45 -07:00
CHANGELOG.md	Add changelog file that points to GitHub Releases & our blog	2015-07-01 15:36:06 -07:00
CNAME	custom cname for v4 alpha	2015-08-18 22:47:18 -07:00
composer.json	remove less references from package files	2015-01-18 19:06:51 -08:00
CONTRIBUTING.md	Remove dropped v3 bootstrap-theme	2015-09-08 08:58:03 +03:00
Gemfile	Use jekyll-sitemap instead of our custom solution.	2015-09-08 08:18:52 +03:00
Gemfile.lock	Use jekyll-sitemap instead of our custom solution.	2015-09-08 08:18:52 +03:00
Gruntfile.js	Remove `gem install scss_lint` from Travis.	2015-09-06 12:28:35 +03:00
LICENSE	Happy New Year 🎅	2015-01-01 01:23:48 +01:00
package.js	Remove the obsolete JSHint references.	2015-08-27 08:11:11 +03:00
package.json	Update devDependencies.	2015-09-05 08:13:43 +03:00
README.md	Added NuGet install instructions to docs	2015-09-08 16:44:21 -07:00
sache.json	Add sache.json	2014-12-15 11:06:10 -08:00

README.md

Bootstrap

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.

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

Quick start
Bugs and feature requests
Documentation
Contributing
Community
Versioning
Creators
Copyright and license

Quick start

Several quick start options are available:

Download the latest release.
Clone the repo: git clone https://github.com/twbs/bootstrap.git.
Install with Bower: bower install bootstrap.
Install with npm: npm install bootstrap.
Install with Meteor: meteor add twbs:bootstrap.
Install with Composer: composer require twbs/bootstrap.
Install with NuGet: CSS: Install-Package bootstrap -Pre Sass: Install-Package bootstrap.sass -Pre (-Pre is only required until Bootstrap v4 has a stable release).

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

What's included

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.css.map
│   ├── bootstrap.min.css
│   └── bootstrap.min.css.map
└── js/
    ├── bootstrap.js
    └── bootstrap.min.js

We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). CSS source maps (bootstrap.*.map) are available for use with certain browsers' developer tools.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

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

If necessary, install Jekyll (requires v2.5.x).

Windows users: Read this unofficial guide to get Jekyll up and running without problems.

Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
From the root /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 its 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/ while folks transition to Bootstrap 3.

Previous releases and their documentation are also available for download.

Contributing

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

Moreover, 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

Get updates on Bootstrap's development and chat with the project maintainers and community members.

Follow @getbootstrap on Twitter.
Read and subscribe to The Official Bootstrap Blog.
Join the official Slack room.
Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##bootstrap channel.
Implementation help may be found at Stack Overflow (tagged twitter-bootstrap-3).
Developers should use the keyword bootstrap on packages which modify or add to the functionality of Bootstrap when distributing through npm or similar delivery mechanisms for maximum discoverability.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

Creators

Mark Otto

Jacob Thornton