Rev 1151 | Rev 1339 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
597 | daniel-mar | 1 | <p align="center"> |
2 | <a href="https://getbootstrap.com/"> |
||
1056 | daniel-mar | 3 | <img src="https://getbootstrap.com/docs/5.3/assets/brand/bootstrap-logo-shadow.png" alt="Bootstrap logo" width="200" height="165"> |
597 | daniel-mar | 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> |
||
1056 | daniel-mar | 12 | <a href="https://getbootstrap.com/docs/5.3/"><strong>Explore Bootstrap docs »</strong></a> |
597 | daniel-mar | 13 | <br> |
14 | <br> |
||
679 | daniel-mar | 15 | <a href="https://github.com/twbs/bootstrap/issues/new?assignees=-&labels=bug&template=bug_report.yml">Report bug</a> |
597 | daniel-mar | 16 | · |
679 | daniel-mar | 17 | <a href="https://github.com/twbs/bootstrap/issues/new?assignees=&labels=feature&template=feature_request.yml">Request feature</a> |
597 | daniel-mar | 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 | |||
27 | Our 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 | |||
47 | Several quick start options are available: |
||
48 | |||
1308 | daniel-mar | 49 | - [Download the latest release](https://github.com/twbs/bootstrap/archive/v5.3.0.zip) |
597 | daniel-mar | 50 | - Clone the repo: `git clone https://github.com/twbs/bootstrap.git` |
1308 | daniel-mar | 51 | - Install with [npm](https://www.npmjs.com/): `npm install bootstrap@v5.3.0` |
52 | - Install with [yarn](https://yarnpkg.com/): `yarn add bootstrap@v5.3.0` |
||
53 | - Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:5.3.0` |
||
597 | daniel-mar | 54 | - Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass` |
55 | |||
1056 | daniel-mar | 56 | Read the [Getting started page](https://getbootstrap.com/docs/5.3/getting-started/introduction/) for information on the framework contents, templates, examples, and more. |
597 | daniel-mar | 57 | |
58 | |||
59 | ## Status |
||
60 | |||
1151 | daniel-mar | 61 | [![Build Status](https://img.shields.io/github/actions/workflow/status/twbs/bootstrap/js.yml?branch=main&label=JS%20Tests&logo=github)](https://github.com/twbs/bootstrap/actions/workflows/js.yml?query=workflow%3AJS+branch%3Amain) |
1056 | daniel-mar | 62 | [![npm version](https://img.shields.io/npm/v/bootstrap?logo=npm&logoColor=fff)](https://www.npmjs.com/package/bootstrap) |
63 | [![Gem version](https://img.shields.io/gem/v/bootstrap?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/bootstrap) |
||
64 | [![Meteor Atmosphere](https://img.shields.io/badge/meteor-twbs%3Abootstrap-blue?logo=meteor&logoColor=fff)](https://atmospherejs.com/twbs/bootstrap) |
||
65 | [![Packagist Prerelease](https://img.shields.io/packagist/vpre/twbs/bootstrap?logo=packagist&logoColor=fff)](https://packagist.org/packages/twbs/bootstrap) |
||
66 | [![NuGet](https://img.shields.io/nuget/vpre/bootstrap?logo=nuget&logoColor=fff)](https://www.nuget.org/packages/bootstrap/absoluteLatest) |
||
67 | [![Coverage Status](https://img.shields.io/coveralls/github/twbs/bootstrap/main?logo=coveralls&logoColor=fff)](https://coveralls.io/github/twbs/bootstrap?branch=main) |
||
597 | daniel-mar | 68 | [![CSS gzip size](https://img.badgesize.io/twbs/bootstrap/main/dist/css/bootstrap.min.css?compression=gzip&label=CSS%20gzip%20size)](https://github.com/twbs/bootstrap/blob/main/dist/css/bootstrap.min.css) |
69 | [![CSS Brotli size](https://img.badgesize.io/twbs/bootstrap/main/dist/css/bootstrap.min.css?compression=brotli&label=CSS%20Brotli%20size)](https://github.com/twbs/bootstrap/blob/main/dist/css/bootstrap.min.css) |
||
70 | [![JS gzip size](https://img.badgesize.io/twbs/bootstrap/main/dist/js/bootstrap.min.js?compression=gzip&label=JS%20gzip%20size)](https://github.com/twbs/bootstrap/blob/main/dist/js/bootstrap.min.js) |
||
71 | [![JS Brotli size](https://img.badgesize.io/twbs/bootstrap/main/dist/js/bootstrap.min.js?compression=brotli&label=JS%20Brotli%20size)](https://github.com/twbs/bootstrap/blob/main/dist/js/bootstrap.min.js) |
||
72 | [![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)](https://www.browserstack.com/automate/public-build/SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229) |
||
1056 | daniel-mar | 73 | [![Backers on Open Collective](https://img.shields.io/opencollective/backers/bootstrap?logo=opencollective&logoColor=fff)](#backers) |
74 | [![Sponsors on Open Collective](https://img.shields.io/opencollective/sponsors/bootstrap?logo=opencollective&logoColor=fff)](#sponsors) |
||
597 | daniel-mar | 75 | |
76 | |||
77 | ## What's included |
||
78 | |||
846 | daniel-mar | 79 | Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. |
597 | daniel-mar | 80 | |
846 | daniel-mar | 81 | <details> |
82 | <summary>Download contents</summary> |
||
597 | daniel-mar | 83 | |
846 | daniel-mar | 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 | |||
679 | daniel-mar | 135 | 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/). |
597 | daniel-mar | 136 | |
137 | |||
138 | ## Bugs and feature requests |
||
139 | |||
931 | daniel-mar | 140 | Have 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). |
597 | daniel-mar | 141 | |
142 | |||
143 | ## Documentation |
||
144 | |||
145 | Bootstrap'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 | |||
1134 | daniel-mar | 147 | Documentation search is powered by [Algolia's DocSearch](https://docsearch.algolia.com/). |
597 | daniel-mar | 148 | |
149 | ### Running documentation locally |
||
150 | |||
151 | 1. Run `npm install` to install the Node.js dependencies, including Hugo (the site builder). |
||
152 | 2. Run `npm run test` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. |
||
153 | 3. From the root `/bootstrap` directory, run `npm run docs-serve` in the command line. |
||
154 | 4. Open `http://localhost:9001/` in your browser, and voilà. |
||
155 | |||
156 | Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/). |
||
157 | |||
158 | ### Documentation for previous releases |
||
159 | |||
160 | You 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 | |||
167 | Please 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 | |||
169 | Moreover, 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 | |||
171 | Editor 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 | |||
176 | Get 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/). |
||
931 | daniel-mar | 180 | - Ask and explore [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions). |
637 | daniel-mar | 181 | - Chat with fellow Bootstrappers in IRC. On the `irc.libera.chat` server, in the `#bootstrap` channel. |
597 | daniel-mar | 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 | |||
188 | 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. |
||
189 | |||
190 | 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. |
||
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/"> |
||
846 | daniel-mar | 209 | <img src="https://live.browserstack.com/images/opensource/browserstack-logo.svg" alt="BrowserStack" width="192" height="42"> |
597 | daniel-mar | 210 | </a> |
211 | |||
212 | Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers! |
||
213 | |||
846 | daniel-mar | 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> |
||
597 | daniel-mar | 217 | |
846 | daniel-mar | 218 | Thanks to [Netlify](https://www.netlify.com/) for providing us with Deploy Previews! |
219 | |||
220 | |||
597 | daniel-mar | 221 | ## Sponsors |
222 | |||
223 | 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)] |
||
224 | |||
225 | [![OC sponsor 0](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website) |
||
226 | [![OC sponsor 1](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website) |
||
227 | [![OC sponsor 2](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website) |
||
228 | [![OC sponsor 3](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website) |
||
229 | [![OC sponsor 4](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website) |
||
230 | [![OC sponsor 5](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website) |
||
231 | [![OC sponsor 6](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website) |
||
232 | [![OC sponsor 7](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website) |
||
233 | [![OC sponsor 8](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website) |
||
234 | [![OC sponsor 9](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website) |
||
235 | |||
236 | |||
237 | ## Backers |
||
238 | |||
239 | Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/bootstrap#backer)] |
||
240 | |||
241 | [![Backers](https://opencollective.com/bootstrap/backers.svg?width=890)](https://opencollective.com/bootstrap#backers) |
||
242 | |||
243 | |||
244 | ## Copyright and license |
||
245 | |||
1134 | daniel-mar | 246 | Code and documentation copyright 2011–2023 the [Bootstrap Authors](https://github.com/twbs/bootstrap/graphs/contributors). 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/). |