1 | <p align="center">
|
2 | <a href="https://getbootstrap.com/">
|
3 | <img src="https://getbootstrap.com/docs/4.5/assets/brand/bootstrap-solid.svg" alt="Bootstrap logo" width="72" height="72">
|
4 | </a>
|
5 | </p>
|
6 |
|
7 | <h3 align="center">Bootstrap</h3>
|
8 |
|
9 | <p align="center">
|
10 | Sleek, intuitive, and powerful front-end framework for faster and easier web development.
|
11 | <br>
|
12 | <a href="https://getbootstrap.com/docs/4.5/"><strong>Explore Bootstrap docs »</strong></a>
|
13 | <br>
|
14 | <br>
|
15 | <a href="https://github.com/twbs/bootstrap/issues/new?template=bug.md">Report bug</a>
|
16 | ·
|
17 | <a href="https://github.com/twbs/bootstrap/issues/new?template=feature.md&labels=feature">Request feature</a>
|
18 | ·
|
19 | <a href="https://themes.getbootstrap.com/">Themes</a>
|
20 | ·
|
21 | <a href="https://blog.getbootstrap.com/">Blog</a>
|
22 | </p>
|
23 |
|
24 |
|
25 | ## Table of contents
|
26 |
|
27 | - [Quick start](#quick-start)
|
28 | - [Status](#status)
|
29 | - [What's included](#whats-included)
|
30 | - [Bugs and feature requests](#bugs-and-feature-requests)
|
31 | - [Documentation](#documentation)
|
32 | - [Contributing](#contributing)
|
33 | - [Community](#community)
|
34 | - [Versioning](#versioning)
|
35 | - [Creators](#creators)
|
36 | - [Thanks](#thanks)
|
37 | - [Copyright and license](#copyright-and-license)
|
38 |
|
39 |
|
40 | ## Quick start
|
41 |
|
42 | Several quick start options are available:
|
43 |
|
44 | - [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.5.0.zip)
|
45 | - Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
|
46 | - Install with [npm](https://www.npmjs.com/): `npm install bootstrap`
|
47 | - Install with [yarn](https://yarnpkg.com/): `yarn add bootstrap@4.5.0`
|
48 | - Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:4.5.0`
|
49 | - Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass`
|
50 |
|
51 | Read the [Getting started page](https://getbootstrap.com/docs/4.5/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
|
52 |
|
53 |
|
54 | ## Status
|
55 |
|
56 | [![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com/)
|
57 | [![Build Status](https://github.com/twbs/bootstrap/workflows/Tests/badge.svg?branch=v4-dev)](https://github.com/twbs/bootstrap/actions?query=workflow%3ATests+branch%3Av4-dev)
|
58 | [![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap)
|
59 | [![Gem version](https://img.shields.io/gem/v/bootstrap.svg)](https://rubygems.org/gems/bootstrap)
|
60 | [![Meteor Atmosphere](https://img.shields.io/badge/meteor-twbs%3Abootstrap-blue.svg)](https://atmospherejs.com/twbs/bootstrap)
|
61 | [![Packagist Prerelease](https://img.shields.io/packagist/vpre/twbs/bootstrap.svg)](https://packagist.org/packages/twbs/bootstrap)
|
62 | [![NuGet](https://img.shields.io/nuget/vpre/bootstrap.svg)](https://www.nuget.org/packages/bootstrap/absoluteLatest)
|
63 | [![peerDependencies Status](https://img.shields.io/david/peer/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=peer)
|
64 | [![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=dev)
|
65 | [![Coverage Status](https://img.shields.io/coveralls/github/twbs/bootstrap/v4-dev.svg)](https://coveralls.io/github/twbs/bootstrap?branch=v4-dev)
|
66 | [![CSS gzip size](https://img.badgesize.io/twbs/bootstrap/v4-dev/dist/css/bootstrap.min.css?compression=gzip&label=CSS+gzip+size)](https://github.com/twbs/bootstrap/tree/v4-dev/dist/css/bootstrap.min.css)
|
67 | [![JS gzip size](https://img.badgesize.io/twbs/bootstrap/v4-dev/dist/js/bootstrap.min.js?compression=gzip&label=JS+gzip+size)](https://github.com/twbs/bootstrap/tree/v4-dev/dist/js/bootstrap.min.js)
|
68 | [![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)](https://www.browserstack.com/automate/public-build/SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)
|
69 | [![Backers on Open Collective](https://opencollective.com/bootstrap/backers/badge.svg)](#backers)
|
70 | [![Sponsors on Open Collective](https://opencollective.com/bootstrap/sponsors/badge.svg)](#sponsors)
|
71 |
|
72 |
|
73 | ## What's included
|
74 |
|
75 | 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:
|
76 |
|
77 | ```text
|
78 | bootstrap/
|
79 | └── dist/
|
80 | ├── css/
|
81 | │ ├── bootstrap-grid.css
|
82 | │ ├── bootstrap-grid.css.map
|
83 | │ ├── bootstrap-grid.min.css
|
84 | │ ├── bootstrap-grid.min.css.map
|
85 | │ ├── bootstrap-reboot.css
|
86 | │ ├── bootstrap-reboot.css.map
|
87 | │ ├── bootstrap-reboot.min.css
|
88 | │ ├── bootstrap-reboot.min.css.map
|
89 | │ ├── bootstrap.css
|
90 | │ ├── bootstrap.css.map
|
91 | │ ├── bootstrap.min.css
|
92 | │ └── bootstrap.min.css.map
|
93 | └── js/
|
94 | ├── bootstrap.bundle.js
|
95 | ├── bootstrap.bundle.js.map
|
96 | ├── bootstrap.bundle.min.js
|
97 | ├── bootstrap.bundle.min.js.map
|
98 | ├── bootstrap.js
|
99 | ├── bootstrap.js.map
|
100 | ├── bootstrap.min.js
|
101 | └── bootstrap.min.js.map
|
102 | ```
|
103 |
|
104 | We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). [source maps](https://developers.google.com/web/tools/chrome-devtools/javascript/source-maps) (`bootstrap.*.map`) are available for use with certain browsers' developer tools. Bundled JS files (`bootstrap.bundle.js` and minified `bootstrap.bundle.min.js`) include [Popper](https://popper.js.org/), but not [jQuery](https://jquery.com/).
|
105 |
|
106 |
|
107 | ## Bugs and feature requests
|
108 |
|
109 | Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/twbs/bootstrap/issues/new).
|
110 |
|
111 |
|
112 | ## Documentation
|
113 |
|
114 | Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages at <https://getbootstrap.com/>. The docs may also be run locally.
|
115 |
|
116 | Documentation search is powered by [Algolia's DocSearch](https://community.algolia.com/docsearch/). Working on our search? Be sure to set `debug: true` in `site/docs/4.5/assets/js/src/search.js` file.
|
117 |
|
118 | ### Running documentation locally
|
119 |
|
120 | 1. Run through the [tooling setup](https://getbootstrap.com/docs/4.5/getting-started/build-tools/#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
|
121 | 2. Run `npm install` to install Node.js dependencies.
|
122 | 3. Run `npm start` to compile CSS and JavaScript files, generate our docs, and watch for changes.
|
123 | 4. Open `http://localhost:9001` in your browser, and voilà.
|
124 |
|
125 | Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/).
|
126 |
|
127 | ### Documentation for previous releases
|
128 |
|
129 | You can find all our previous releases docs on <https://getbootstrap.com/docs/versions/>.
|
130 |
|
131 | [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
|
132 |
|
133 |
|
134 | ## Contributing
|
135 |
|
136 | Please read through our [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
|
137 |
|
138 | Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/twbs/bootstrap/tree/master/js/tests). All HTML and CSS should conform to the [Code Guide](https://github.com/mdo/code-guide), maintained by [Mark Otto](https://github.com/mdo).
|
139 |
|
140 | Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
|
141 |
|
142 |
|
143 | ## Community
|
144 |
|
145 | Get updates on Bootstrap's development and chat with the project maintainers and community members.
|
146 |
|
147 | - Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
|
148 | - Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com/).
|
149 | - Join [the official Slack room](https://bootstrap-slack.herokuapp.com/).
|
150 | - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
|
151 | - Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
|
152 | - Developers should use the keyword `bootstrap` on packages which modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/browse/keyword/bootstrap) or similar delivery mechanisms for maximum discoverability.
|
153 |
|
154 |
|
155 | ## Versioning
|
156 |
|
157 | For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](https://semver.org/). Sometimes we screw up, but we adhere to those rules whenever possible.
|
158 |
|
159 | See [the Releases section of our GitHub project](https://github.com/twbs/bootstrap/releases) for changelogs for each release version of Bootstrap. Release announcement posts on [the official Bootstrap blog](https://blog.getbootstrap.com/) contain summaries of the most noteworthy changes made in each release.
|
160 |
|
161 |
|
162 | ## Creators
|
163 |
|
164 | **Mark Otto**
|
165 |
|
166 | - <https://twitter.com/mdo>
|
167 | - <https://github.com/mdo>
|
168 |
|
169 | **Jacob Thornton**
|
170 |
|
171 | - <https://twitter.com/fat>
|
172 | - <https://github.com/fat>
|
173 |
|
174 |
|
175 | ## Thanks
|
176 |
|
177 | <a href="https://www.browserstack.com/">
|
178 | <img src="https://live.browserstack.com/images/opensource/browserstack-logo.svg" alt="BrowserStack Logo" width="192" height="42">
|
179 | </a>
|
180 |
|
181 | Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers!
|
182 |
|
183 |
|
184 | ## Sponsors
|
185 |
|
186 | Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/bootstrap#sponsor)]
|
187 |
|
188 | [![](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website)
|
189 | [![](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website)
|
190 | [![](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website)
|
191 | [![](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website)
|
192 | [![](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website)
|
193 | [![](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website)
|
194 | [![](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website)
|
195 | [![](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website)
|
196 | [![](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website)
|
197 | [![](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website)
|
198 |
|
199 |
|
200 | ## Backers
|
201 |
|
202 | Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/bootstrap#backer)]
|
203 |
|
204 | [![Backers](https://opencollective.com/bootstrap/backers.svg?width=890)](https://opencollective.com/bootstrap#backers)
|
205 |
|
206 |
|
207 | ## Copyright and license
|
208 |
|
209 | Code and documentation copyright 2011-2020 the [Bootstrap Authors](https://github.com/twbs/bootstrap/graphs/contributors) and [Twitter, Inc.](https://twitter.com) Code released under the [MIT License](https://github.com/twbs/bootstrap/blob/master/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
|