README.md
1<p align="center">
2 <a href="https://getbootstrap.com/">
3 <img src="https://getbootstrap.com/docs/5.2/assets/brand/bootstrap-logo-shadow.png" alt="Bootstrap logo" width="200" height="165">
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/5.2/"><strong>Explore Bootstrap docs ��</strong></a>
13 <br>
14 <br>
15 <a href="https://github.com/twbs/bootstrap/issues/new?assignees=-&labels=bug&template=bug_report.yml">Report bug</a>
16 ��
17 <a href="https://github.com/twbs/bootstrap/issues/new?assignees=&labels=feature&template=feature_request.yml">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## Bootstrap 5
26
27Our default branch is for development of our Bootstrap 5 release. Head to the [`v4-dev` branch](https://github.com/twbs/bootstrap/tree/v4-dev) to view the readme, documentation, and source code for Bootstrap 4.
28
29
30## Table of contents
31
32- [Quick start](#quick-start)
33- [Status](#status)
34- [What's included](#whats-included)
35- [Bugs and feature requests](#bugs-and-feature-requests)
36- [Documentation](#documentation)
37- [Contributing](#contributing)
38- [Community](#community)
39- [Versioning](#versioning)
40- [Creators](#creators)
41- [Thanks](#thanks)
42- [Copyright and license](#copyright-and-license)
43
44
45## Quick start
46
47Several quick start options are available:
48
49- [Download the latest release](https://github.com/twbs/bootstrap/archive/v5.2.0.zip)
50- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
51- Install with [npm](https://www.npmjs.com/): `npm install bootstrap@v5.2.0`
52- Install with [yarn](https://yarnpkg.com/): `yarn add bootstrap@v5.2.0`
53- Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:5.2.0`
54- Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass`
55
56Read the [Getting started page](https://getbootstrap.com/docs/5.2/getting-started/introduction/) for information on the framework contents, templates, examples, and more.
57
58
59## Status
60
61[](https://github.com/twbs/bootstrap/actions?query=workflow%3AJS+Tests+branch%3Amain)
62[](https://www.npmjs.com/package/bootstrap)
63[](https://rubygems.org/gems/bootstrap)
64[](https://atmospherejs.com/twbs/bootstrap)
65[](https://packagist.org/packages/twbs/bootstrap)
66[](https://www.nuget.org/packages/bootstrap/absoluteLatest)
67[](https://coveralls.io/github/twbs/bootstrap?branch=main)
68[](https://github.com/twbs/bootstrap/blob/main/dist/css/bootstrap.min.css)
69[](https://github.com/twbs/bootstrap/blob/main/dist/css/bootstrap.min.css)
70[](https://github.com/twbs/bootstrap/blob/main/dist/js/bootstrap.min.js)
71[](https://github.com/twbs/bootstrap/blob/main/dist/js/bootstrap.min.js)
72[](https://www.browserstack.com/automate/public-build/SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)
73[](#backers)
74[](#sponsors)
75
76
77## What's included
78
79Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.
80
81<details>
82 <summary>Download contents</summary>
83
84 ```text
85 bootstrap/
86 ��������� css/
87 ��� ��������� bootstrap-grid.css
88 ��� ��������� bootstrap-grid.css.map
89 ��� ��������� bootstrap-grid.min.css
90 ��� ��������� bootstrap-grid.min.css.map
91 ��� ��������� bootstrap-grid.rtl.css
92 ��� ��������� bootstrap-grid.rtl.css.map
93 ��� ��������� bootstrap-grid.rtl.min.css
94 ��� ��������� bootstrap-grid.rtl.min.css.map
95 ��� ��������� bootstrap-reboot.css
96 ��� ��������� bootstrap-reboot.css.map
97 ��� ��������� bootstrap-reboot.min.css
98 ��� ��������� bootstrap-reboot.min.css.map
99 ��� ��������� bootstrap-reboot.rtl.css
100 ��� ��������� bootstrap-reboot.rtl.css.map
101 ��� ��������� bootstrap-reboot.rtl.min.css
102 ��� ��������� bootstrap-reboot.rtl.min.css.map
103 ��� ��������� bootstrap-utilities.css
104 ��� ��������� bootstrap-utilities.css.map
105 ��� ��������� bootstrap-utilities.min.css
106 ��� ��������� bootstrap-utilities.min.css.map
107 ��� ��������� bootstrap-utilities.rtl.css
108 ��� ��������� bootstrap-utilities.rtl.css.map
109 ��� ��������� bootstrap-utilities.rtl.min.css
110 ��� ��������� bootstrap-utilities.rtl.min.css.map
111 ��� ��������� bootstrap.css
112 ��� ��������� bootstrap.css.map
113 ��� ��������� bootstrap.min.css
114 ��� ��������� bootstrap.min.css.map
115 ��� ��������� bootstrap.rtl.css
116 ��� ��������� bootstrap.rtl.css.map
117 ��� ��������� bootstrap.rtl.min.css
118 ��� ��������� bootstrap.rtl.min.css.map
119 ��������� js/
120 ��������� bootstrap.bundle.js
121 ��������� bootstrap.bundle.js.map
122 ��������� bootstrap.bundle.min.js
123 ��������� bootstrap.bundle.min.js.map
124 ��������� bootstrap.esm.js
125 ��������� bootstrap.esm.js.map
126 ��������� bootstrap.esm.min.js
127 ��������� bootstrap.esm.min.js.map
128 ��������� bootstrap.js
129 ��������� bootstrap.js.map
130 ��������� bootstrap.min.js
131 ��������� bootstrap.min.js.map
132 ```
133</details>
134
135We 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/).
136
137
138## Bugs and feature requests
139
140Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/main/.github/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/choose).
141
142
143## Documentation
144
145Bootstrap's documentation, included in this repo in the root directory, is built with [Hugo](https://gohugo.io/) and publicly hosted on GitHub Pages at <https://getbootstrap.com/>. The docs may also be run locally.
146
147Documentation search is powered by [Algolia's DocSearch](https://docsearch.algolia.com/). Working on our search? Be sure to set `debug: true` in `site/assets/js/search.js`.
148
149### Running documentation locally
150
1511. Run `npm install` to install the Node.js dependencies, including Hugo (the site builder).
1522. Run `npm run test` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
1533. From the root `/bootstrap` directory, run `npm run docs-serve` in the command line.
1544. Open `http://localhost:9001/` in your browser, and voil��.
155
156Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/).
157
158### Documentation for previous releases
159
160You can find all our previous releases docs on <https://getbootstrap.com/docs/versions/>.
161
162[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
163
164
165## Contributing
166
167Please read through our [contributing guidelines](https://github.com/twbs/bootstrap/blob/main/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
168
169Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/twbs/bootstrap/tree/main/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).
170
171Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/main/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
172
173
174## Community
175
176Get updates on Bootstrap's development and chat with the project maintainers and community members.
177
178- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
179- Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com/).
180- Ask and explore [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions).
181- Chat with fellow Bootstrappers in IRC. On the `irc.libera.chat` server, in the `#bootstrap` channel.
182- Implementation help may be found at Stack Overflow (tagged [`bootstrap-5`](https://stackoverflow.com/questions/tagged/bootstrap-5)).
183- 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.
184
185
186## Versioning
187
188For 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.
189
190See [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.
191
192
193## Creators
194
195**Mark Otto**
196
197- <https://twitter.com/mdo>
198- <https://github.com/mdo>
199
200**Jacob Thornton**
201
202- <https://twitter.com/fat>
203- <https://github.com/fat>
204
205
206## Thanks
207
208<a href="https://www.browserstack.com/">
209 <img src="https://live.browserstack.com/images/opensource/browserstack-logo.svg" alt="BrowserStack" width="192" height="42">
210</a>
211
212Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers!
213
214<a href="https://www.netlify.com/">
215 <img src="https://www.netlify.com/v3/img/components/full-logo-light.svg" alt="Netlify" width="147" height="40">
216</a>
217
218Thanks to [Netlify](https://www.netlify.com/) for providing us with Deploy Previews!
219
220
221## Sponsors
222
223Support 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)]
224
225[](https://opencollective.com/bootstrap/sponsor/0/website)
226[](https://opencollective.com/bootstrap/sponsor/1/website)
227[](https://opencollective.com/bootstrap/sponsor/2/website)
228[](https://opencollective.com/bootstrap/sponsor/3/website)
229[](https://opencollective.com/bootstrap/sponsor/4/website)
230[](https://opencollective.com/bootstrap/sponsor/5/website)
231[](https://opencollective.com/bootstrap/sponsor/6/website)
232[](https://opencollective.com/bootstrap/sponsor/7/website)
233[](https://opencollective.com/bootstrap/sponsor/8/website)
234[](https://opencollective.com/bootstrap/sponsor/9/website)
235
236
237## Backers
238
239Thank you to all our backers! ���� [[Become a backer](https://opencollective.com/bootstrap#backer)]
240
241[](https://opencollective.com/bootstrap#backers)
242
243
244## Copyright and license
245
246Code and documentation copyright 2011���2022 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/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
247
