mirror of
https://github.com/twbs/bootstrap.git
synced 2024-11-29 11:24:18 +01:00
225 lines
13 KiB
Markdown
225 lines
13 KiB
Markdown
<p align="center">
|
||
<a href="https://v5.getbootstrap.com/">
|
||
<img src="https://v5.getbootstrap.com/docs/5.0/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://v5.getbootstrap.com/docs/5.0/"><strong>Explore Bootstrap docs »</strong></a>
|
||
<br>
|
||
<br>
|
||
<a href="https://github.com/twbs/bootstrap/issues/new?template=bug_report.md">Report bug</a>
|
||
·
|
||
<a href="https://github.com/twbs/bootstrap/issues/new?template=feature_request.md">Request feature</a>
|
||
·
|
||
<a href="https://themes.getbootstrap.com/">Themes</a>
|
||
·
|
||
<a href="https://blog.getbootstrap.com/">Blog</a>
|
||
</p>
|
||
|
||
|
||
## Bootstrap 4
|
||
|
||
Our default branch is for development of our upcoming 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.0.0-alpha3.zip)
|
||
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
|
||
- Install with [npm](https://www.npmjs.com/): `npm install bootstrap@next`
|
||
- Install with [yarn](https://yarnpkg.com/): `yarn add bootstrap@next`
|
||
- Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:5.0.0-alpha3`
|
||
- Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass`
|
||
|
||
Read the [Getting started page](https://v5.getbootstrap.com/docs/5.0/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
|
||
|
||
|
||
## Status
|
||
|
||
[](https://bootstrap-slack.herokuapp.com/)
|
||
[](https://github.com/twbs/bootstrap/actions?query=workflow%3AJS+Tests+branch%3Amain)
|
||
[](https://www.npmjs.com/package/bootstrap)
|
||
[](https://rubygems.org/gems/bootstrap)
|
||
[](https://atmospherejs.com/twbs/bootstrap)
|
||
[](https://packagist.org/packages/twbs/bootstrap)
|
||
[](https://www.nuget.org/packages/bootstrap/absoluteLatest)
|
||
[](https://david-dm.org/twbs/bootstrap?type=peer)
|
||
[](https://david-dm.org/twbs/bootstrap?type=dev)
|
||
[](https://coveralls.io/github/twbs/bootstrap?branch=main)
|
||
[](https://github.com/twbs/bootstrap/blob/main/dist/css/bootstrap.min.css)
|
||
[](https://github.com/twbs/bootstrap/blob/main/dist/css/bootstrap.min.css)
|
||
[](https://github.com/twbs/bootstrap/blob/main/dist/js/bootstrap.min.js)
|
||
[](https://github.com/twbs/bootstrap/blob/main/dist/js/bootstrap.min.js)
|
||
[](https://www.browserstack.com/automate/public-build/SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)
|
||
[](#backers)
|
||
[](#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. You'll see something like this:
|
||
|
||
```text
|
||
bootstrap/
|
||
└── dist/
|
||
├── css/
|
||
│ ├── bootstrap-grid.css
|
||
│ ├── bootstrap-grid.css.map
|
||
│ ├── bootstrap-grid.min.css
|
||
│ ├── bootstrap-grid.min.css.map
|
||
│ ├── bootstrap-reboot.css
|
||
│ ├── bootstrap-reboot.css.map
|
||
│ ├── bootstrap-reboot.min.css
|
||
│ ├── bootstrap-reboot.min.css.map
|
||
│ ├── bootstrap-utilities.css
|
||
│ ├── bootstrap-utilities.css.map
|
||
│ ├── bootstrap-utilities.min.css
|
||
│ ├── bootstrap-utilities.min.css.map
|
||
│ ├── bootstrap.css
|
||
│ ├── bootstrap.css.map
|
||
│ ├── bootstrap.min.css
|
||
│ └── bootstrap.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](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).
|
||
|
||
|
||
## 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://v5.getbootstrap.com/>. The docs may also be run locally.
|
||
|
||
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/assets/js/search.js`.
|
||
|
||
### 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://v5.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/).
|
||
- Join [the official Slack room](https://bootstrap-slack.herokuapp.com/).
|
||
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` 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 Logo" width="192" height="42">
|
||
</a>
|
||
|
||
Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers!
|
||
|
||
|
||
## 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)]
|
||
|
||
[](https://opencollective.com/bootstrap/sponsor/0/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/1/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/2/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/3/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/4/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/5/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/6/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/7/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/8/website)
|
||
[](https://opencollective.com/bootstrap/sponsor/9/website)
|
||
|
||
|
||
## Backers
|
||
|
||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/bootstrap#backer)]
|
||
|
||
[](https://opencollective.com/bootstrap#backers)
|
||
|
||
|
||
## Copyright and license
|
||
|
||
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/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
|