-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
176 changed files
with
21,193 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2011-2024 The Bootstrap Authors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,246 @@ | ||
<p align="center"> | ||
<a href="https://getbootstrap.com/"> | ||
<img src="https://getbootstrap.com/docs/5.3/assets/brand/bootstrap-logo-shadow.png" alt="Bootstrap logo" width="200" height="165"> | ||
</a> | ||
</p> | ||
|
||
<h3 align="center">Bootstrap</h3> | ||
|
||
<p align="center"> | ||
Sleek, intuitive, and powerful front-end framework for faster and easier web development. | ||
<br> | ||
<a href="https://getbootstrap.com/docs/5.3/"><strong>Explore Bootstrap docs »</strong></a> | ||
<br> | ||
<br> | ||
<a href="https://github.com/twbs/bootstrap/issues/new?assignees=-&labels=bug&template=bug_report.yml">Report bug</a> | ||
· | ||
<a href="https://github.com/twbs/bootstrap/issues/new?assignees=&labels=feature&template=feature_request.yml">Request feature</a> | ||
· | ||
<a href="https://themes.getbootstrap.com/">Themes</a> | ||
· | ||
<a href="https://blog.getbootstrap.com/">Blog</a> | ||
</p> | ||
|
||
|
||
## Bootstrap 5 | ||
|
||
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. | ||
|
||
|
||
## Table of contents | ||
|
||
- [Quick start](#quick-start) | ||
- [Status](#status) | ||
- [What's included](#whats-included) | ||
- [Bugs and feature requests](#bugs-and-feature-requests) | ||
- [Documentation](#documentation) | ||
- [Contributing](#contributing) | ||
- [Community](#community) | ||
- [Versioning](#versioning) | ||
- [Creators](#creators) | ||
- [Thanks](#thanks) | ||
- [Copyright and license](#copyright-and-license) | ||
|
||
|
||
## Quick start | ||
|
||
Several quick start options are available: | ||
|
||
- [Download the latest release](https://github.com/twbs/bootstrap/archive/v5.3.3.zip) | ||
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git` | ||
- Install with [npm](https://www.npmjs.com/): `npm install [email protected]` | ||
- Install with [yarn](https://yarnpkg.com/): `yarn add [email protected]` | ||
- Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:5.3.3` | ||
- Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass` | ||
|
||
Read the [Getting started page](https://getbootstrap.com/docs/5.3/getting-started/introduction/) for information on the framework contents, templates, examples, and more. | ||
|
||
|
||
## Status | ||
|
||
[![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) | ||
[![npm version](https://img.shields.io/npm/v/bootstrap?logo=npm&logoColor=fff)](https://www.npmjs.com/package/bootstrap) | ||
[![Gem version](https://img.shields.io/gem/v/bootstrap?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/bootstrap) | ||
[![Meteor Atmosphere](https://img.shields.io/badge/meteor-twbs%3Abootstrap-blue?logo=meteor&logoColor=fff)](https://atmospherejs.com/twbs/bootstrap) | ||
[![Packagist Prerelease](https://img.shields.io/packagist/vpre/twbs/bootstrap?logo=packagist&logoColor=fff)](https://packagist.org/packages/twbs/bootstrap) | ||
[![NuGet](https://img.shields.io/nuget/vpre/bootstrap?logo=nuget&logoColor=fff)](https://www.nuget.org/packages/bootstrap/absoluteLatest) | ||
[![Coverage Status](https://img.shields.io/coveralls/github/twbs/bootstrap/main?logo=coveralls&logoColor=fff)](https://coveralls.io/github/twbs/bootstrap?branch=main) | ||
[![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) | ||
[![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) | ||
[![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) | ||
[![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) | ||
[![Backers on Open Collective](https://img.shields.io/opencollective/backers/bootstrap?logo=opencollective&logoColor=fff)](#backers) | ||
[![Sponsors on Open Collective](https://img.shields.io/opencollective/sponsors/bootstrap?logo=opencollective&logoColor=fff)](#sponsors) | ||
|
||
|
||
## 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. | ||
|
||
<details> | ||
<summary>Download contents</summary> | ||
|
||
```text | ||
bootstrap/ | ||
├── css/ | ||
│ ├── bootstrap-grid.css | ||
│ ├── bootstrap-grid.css.map | ||
│ ├── bootstrap-grid.min.css | ||
│ ├── bootstrap-grid.min.css.map | ||
│ ├── bootstrap-grid.rtl.css | ||
│ ├── bootstrap-grid.rtl.css.map | ||
│ ├── bootstrap-grid.rtl.min.css | ||
│ ├── bootstrap-grid.rtl.min.css.map | ||
│ ├── bootstrap-reboot.css | ||
│ ├── bootstrap-reboot.css.map | ||
│ ├── bootstrap-reboot.min.css | ||
│ ├── bootstrap-reboot.min.css.map | ||
│ ├── bootstrap-reboot.rtl.css | ||
│ ├── bootstrap-reboot.rtl.css.map | ||
│ ├── bootstrap-reboot.rtl.min.css | ||
│ ├── bootstrap-reboot.rtl.min.css.map | ||
│ ├── bootstrap-utilities.css | ||
│ ├── bootstrap-utilities.css.map | ||
│ ├── bootstrap-utilities.min.css | ||
│ ├── bootstrap-utilities.min.css.map | ||
│ ├── bootstrap-utilities.rtl.css | ||
│ ├── bootstrap-utilities.rtl.css.map | ||
│ ├── bootstrap-utilities.rtl.min.css | ||
│ ├── bootstrap-utilities.rtl.min.css.map | ||
│ ├── bootstrap.css | ||
│ ├── bootstrap.css.map | ||
│ ├── bootstrap.min.css | ||
│ ├── bootstrap.min.css.map | ||
│ ├── bootstrap.rtl.css | ||
│ ├── bootstrap.rtl.css.map | ||
│ ├── bootstrap.rtl.min.css | ||
│ └── bootstrap.rtl.min.css.map | ||
└── js/ | ||
├── bootstrap.bundle.js | ||
├── bootstrap.bundle.js.map | ||
├── bootstrap.bundle.min.js | ||
├── bootstrap.bundle.min.js.map | ||
├── bootstrap.esm.js | ||
├── bootstrap.esm.js.map | ||
├── bootstrap.esm.min.js | ||
├── bootstrap.esm.min.js.map | ||
├── bootstrap.js | ||
├── bootstrap.js.map | ||
├── bootstrap.min.js | ||
└── bootstrap.min.js.map | ||
``` | ||
</details> | ||
|
||
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/). | ||
|
||
|
||
## Bugs and feature requests | ||
|
||
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). | ||
|
||
|
||
## Documentation | ||
|
||
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. | ||
|
||
Documentation search is powered by [Algolia's DocSearch](https://docsearch.algolia.com/). | ||
|
||
### Running documentation locally | ||
|
||
1. Run `npm install` to install the Node.js dependencies, including Hugo (the site builder). | ||
2. Run `npm run test` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. | ||
3. From the root `/bootstrap` directory, run `npm run docs-serve` in the command line. | ||
4. Open `http://localhost:9001/` in your browser, and voilà. | ||
|
||
Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/). | ||
|
||
### Documentation for previous releases | ||
|
||
You can find all our previous releases docs on <https://getbootstrap.com/docs/versions/>. | ||
|
||
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download. | ||
|
||
|
||
## Contributing | ||
|
||
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. | ||
|
||
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). | ||
|
||
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/>. | ||
|
||
|
||
## Community | ||
|
||
Get updates on Bootstrap's development and chat with the project maintainers and community members. | ||
|
||
- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap). | ||
- Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com/). | ||
- Ask questions and explore [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions). | ||
- Discuss, ask questions, and more on [the community Discord](https://discord.gg/bZUvakRU3M) or [Bootstrap subreddit](https://reddit.com/r/bootstrap). | ||
- Chat with fellow Bootstrappers in IRC. On the `irc.libera.chat` server, in the `#bootstrap` channel. | ||
- Implementation help may be found at Stack Overflow (tagged [`bootstrap-5`](https://stackoverflow.com/questions/tagged/bootstrap-5)). | ||
- 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. | ||
|
||
|
||
## Versioning | ||
|
||
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. | ||
|
||
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. | ||
|
||
|
||
## Creators | ||
|
||
**Mark Otto** | ||
|
||
- <https://twitter.com/mdo> | ||
- <https://github.com/mdo> | ||
|
||
**Jacob Thornton** | ||
|
||
- <https://twitter.com/fat> | ||
- <https://github.com/fat> | ||
|
||
|
||
## Thanks | ||
|
||
<a href="https://www.browserstack.com/"> | ||
<img src="https://live.browserstack.com/images/opensource/browserstack-logo.svg" alt="BrowserStack" width="192" height="42"> | ||
</a> | ||
|
||
Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers! | ||
|
||
<a href="https://www.netlify.com/"> | ||
<img src="https://www.netlify.com/v3/img/components/full-logo-light.svg" alt="Netlify" width="147" height="40"> | ||
</a> | ||
|
||
Thanks to [Netlify](https://www.netlify.com/) for providing us with Deploy Previews! | ||
|
||
|
||
## Sponsors | ||
|
||
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)] | ||
|
||
[![OC sponsor 0](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website) | ||
[![OC sponsor 1](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website) | ||
[![OC sponsor 2](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website) | ||
[![OC sponsor 3](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website) | ||
[![OC sponsor 4](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website) | ||
[![OC sponsor 5](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website) | ||
[![OC sponsor 6](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website) | ||
[![OC sponsor 7](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website) | ||
[![OC sponsor 8](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website) | ||
[![OC sponsor 9](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website) | ||
|
||
|
||
## Backers | ||
|
||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/bootstrap#backer)] | ||
|
||
[![Backers](https://opencollective.com/bootstrap/backers.svg?width=890)](https://opencollective.com/bootstrap#backers) | ||
|
||
|
||
## Copyright and license | ||
|
||
Code and documentation copyright 2011–2024 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/). |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.