tree: 1b1d80bf49a42d683891e33d04f19da0c3fe0c7f [path history] [tgz]
  1. .github/
  2. build/
  3. dist/
  4. js/
  5. nuget/
  6. scss/
  7. site/
  8. .babelrc.js
  9. .browserslistrc
  10. .bundlewatch.config.json
  11. .cspell.json
  12. .editorconfig
  13. .eslintignore
  14. .eslintrc.json
  15. .gitattributes
  16. .gitignore
  17. .npmrc
  18. .stylelintignore
  19. .stylelintrc.json
  20. CODE_OF_CONDUCT.md
  21. composer.json
  22. hugo.yml
  23. LICENSE
  24. package-lock.json
  25. package.js
  26. package.json
  27. README.md
  28. SECURITY.md
README.md

Bootstrap 5

Our default branch is for development of our Bootstrap 5 release. Head to the v4-dev branch to view the readme, documentation, and source code for Bootstrap 4.

Table of contents

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 npm: npm install bootstrap@v5.3.1
  • Install with yarn: yarn add bootstrap@v5.3.1
  • Install with Composer: composer require twbs/bootstrap:5.3.1
  • Install with NuGet: CSS: Install-Package bootstrap Sass: Install-Package bootstrap.sass

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

Status

Build Status npm version Gem version Meteor Atmosphere Packagist Prerelease NuGet Coverage Status CSS gzip size CSS Brotli size JS gzip size JS Brotli size Backers on Open Collective Sponsors on Open Collective

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.

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

We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). 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.

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 Hugo 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.

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.

Documentation for previous releases

You can find all our previous releases docs on https://getbootstrap.com/docs/versions/.

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 https://editorconfig.org/.

Community

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

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 adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of Bootstrap. Release announcement posts on the official Bootstrap blog contain summaries of the most noteworthy changes made in each release.

Creators

Mark Otto

Jacob Thornton

Thanks

Thanks to BrowserStack for providing the infrastructure that allows us to test in real browsers!

Thanks to Netlify 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]

OC sponsor 0 OC sponsor 1 OC sponsor 2 OC sponsor 3 OC sponsor 4 OC sponsor 5 OC sponsor 6 OC sponsor 7 OC sponsor 8 OC sponsor 9

Backers

Thank you to all our backers! 🙏 [Become a backer]

Backers

Copyright and license

Code and documentation copyright 2011–2023 the Bootstrap Authors. Code released under the MIT License. Docs released under Creative Commons.