README.md 11.8 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
<p align="center">
XhmikosR's avatar
XhmikosR committed
2
  <a href="https://getbootstrap.com/">
Mark Otto's avatar
Mark Otto committed
3
    <img src="https://getbootstrap.com/docs/4.3/assets/brand/bootstrap-solid.svg" alt="Bootstrap logo" width="72" height="72">
Mark Otto's avatar
Mark Otto committed
4
  </a>
5
</p>
Mark Otto's avatar
Mark Otto committed
6

7
<h3 align="center">Bootstrap</h3>
Mark Otto's avatar
Mark Otto committed
8

9
10
11
<p align="center">
  Sleek, intuitive, and powerful front-end framework for faster and easier web development.
  <br>
Mark Otto's avatar
Mark Otto committed
12
  <a href="https://getbootstrap.com/docs/4.3/"><strong>Explore Bootstrap docs »</strong></a>
13
14
15
16
17
18
19
20
21
  <br>
  <br>
  <a href="https://github.com/twbs/bootstrap/issues/new?template=bug.md">Report bug</a>
  ·
  <a href="https://github.com/twbs/bootstrap/issues/new?template=feature.md&labels=feature">Request feature</a>
  ·
  <a href="https://themes.getbootstrap.com/">Themes</a>
  ·
  <a href="https://blog.getbootstrap.com/">Blog</a>
Mark Otto's avatar
Mark Otto committed
22
</p>
Mark Otto's avatar
Mark Otto committed
23

Mark Otto's avatar
Mark Otto committed
24

25
26
## Table of contents

27
- [Quick start](#quick-start)
Mark Otto's avatar
Mark Otto committed
28
- [Status](#status)
Mark Otto's avatar
Mark Otto committed
29
- [What's included](#whats-included)
30
31
32
33
34
35
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Community](#community)
- [Versioning](#versioning)
- [Creators](#creators)
36
- [Thanks](#thanks)
37
- [Copyright and license](#copyright-and-license)
Mark Otto's avatar
Mark Otto committed
38

XhmikosR's avatar
XhmikosR committed
39

Mark Otto's avatar
Mark Otto committed
40
## Quick start
Mark Otto's avatar
Mark Otto committed
41

42
Several quick start options are available:
43

XhmikosR's avatar
XhmikosR committed
44
- [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.3.1.zip)
45
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
Mark Otto's avatar
Mark Otto committed
46
- Install with [npm](https://www.npmjs.com/): `npm install bootstrap`
XhmikosR's avatar
XhmikosR committed
47
48
- Install with [yarn](https://yarnpkg.com/): `yarn add bootstrap@4.3.1`
- Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:4.3.1`
vsn4ik's avatar
vsn4ik committed
49
- Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass`
Jacob Thornton's avatar
Jacob Thornton committed
50

Mark Otto's avatar
Mark Otto committed
51
Read the [Getting started page](https://getbootstrap.com/docs/4.3/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
52

XhmikosR's avatar
XhmikosR committed
53

Mark Otto's avatar
Mark Otto committed
54
## Status
Mark Otto's avatar
Mark Otto committed
55

56
[![Build Status](https://github.com/twbs/bootstrap/workflows/Tests/badge.svg)](https://github.com/twbs/bootstrap/actions?workflow=Tests)
Mark Otto's avatar
Mark Otto committed
57
58
59
60
[![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap)
[![Gem version](https://img.shields.io/gem/v/bootstrap.svg)](https://rubygems.org/gems/bootstrap)
[![Meteor Atmosphere](https://img.shields.io/badge/meteor-twbs%3Abootstrap-blue.svg)](https://atmospherejs.com/twbs/bootstrap)
[![Packagist Prerelease](https://img.shields.io/packagist/vpre/twbs/bootstrap.svg)](https://packagist.org/packages/twbs/bootstrap)
61
[![NuGet](https://img.shields.io/nuget/vpre/bootstrap.svg)](https://www.nuget.org/packages/bootstrap/absoluteLatest)
XhmikosR's avatar
XhmikosR committed
62
63
[![peerDependencies Status](https://img.shields.io/david/peer/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=peer)
[![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=dev)
64
65
66
[![Coverage Status](https://img.shields.io/coveralls/github/twbs/bootstrap/master.svg)](https://coveralls.io/github/twbs/bootstrap?branch=master)
[![CSS gzip size](https://img.badgesize.io/twbs/bootstrap/master/dist/css/bootstrap.min.css?compression=gzip&label=CSS+gzip+size)](https://github.com/twbs/bootstrap/tree/master/dist/css/bootstrap.min.css)
[![JS gzip size](https://img.badgesize.io/twbs/bootstrap/master/dist/js/bootstrap.min.js?compression=gzip&label=JS+gzip+size)](https://github.com/twbs/bootstrap/tree/master/dist/js/bootstrap.min.js)
67
[![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)](https://www.browserstack.com/automate/public-build/SkxZcStBeExEdVJqQ2hWYnlWckpkNmNEY213SFp6WHFETWk2bGFuY3pCbz0tLXhqbHJsVlZhQnRBdEpod3NLSDMzaHc9PQ==--3d0b75245708616eb93113221beece33e680b229)
68
69
[![Backers on Open Collective](https://img.shields.io/opencollective/backers/bootstrap.svg)](#backers)
[![Sponsors on Open Collective](https://img.shields.io/opencollective/sponsors/bootstrap.svg)](#sponsors)
Mark Otto's avatar
Mark Otto committed
70

XhmikosR's avatar
XhmikosR committed
71

Mark Otto's avatar
Mark Otto committed
72
## What's included
73
74
75

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:

XhmikosR's avatar
XhmikosR committed
76
```text
77
bootstrap/
78
79
80
81
82
83
84
85
86
87
└── 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
julian-hecker's avatar
julian-hecker committed
88
89
90
91
    │   ├── bootstrap-utilities.css
    │   ├── bootstrap-utilities.css.map
    │   ├── bootstrap-utilities.min.css
    │   ├── bootstrap-utilities.min.css.map
92
93
94
95
96
97
98
99
100
    │   ├── 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
101
102
103
104
        ├── bootstrap.esm.js
        ├── bootstrap.esm.js.map
        ├── bootstrap.esm.min.js
        ├── bootstrap.esm.min.js.map
105
106
107
108
        ├── bootstrap.js
        ├── bootstrap.js.map
        ├── bootstrap.min.js
        └── bootstrap.min.js.map
109
110
```

XhmikosR's avatar
XhmikosR committed
111
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/).
Mark Otto's avatar
Mark Otto committed
112

Mark Otto's avatar
Mark Otto committed
113

Mark Otto's avatar
Mark Otto committed
114
## Bugs and feature requests
Mark Otto's avatar
Mark Otto committed
115

116
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/.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).
117
118


119
## Documentation
120

XhmikosR's avatar
XhmikosR committed
121
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.
122

123
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/src/search.js` file.
Mark Otto's avatar
Mark Otto committed
124

125
126
### Running documentation locally

XhmikosR's avatar
XhmikosR committed
127
128
129
130
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à.
131

XhmikosR's avatar
XhmikosR committed
132
Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/).
133
134
135

### Documentation for previous releases

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

138
[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
139
140


Mark Otto's avatar
Mark Otto committed
141
142
## Contributing

143
Please read through our [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
144

145
Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/twbs/bootstrap/tree/master/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).
Jacob Thornton's avatar
Jacob Thornton committed
146

147
Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
Jacob Thornton's avatar
Jacob Thornton committed
148

Mark Otto's avatar
Mark Otto committed
149

Mark Otto's avatar
Mark Otto committed
150
151
## Community

152
Get updates on Bootstrap's development and chat with the project maintainers and community members.
Mark Otto's avatar
Mark Otto committed
153

154
- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
XhmikosR's avatar
XhmikosR committed
155
156
- Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com/).
- Join [the official Slack room](https://bootstrap-slack.herokuapp.com/).
Siecje's avatar
Siecje committed
157
- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
158
- Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
Kevin Kirsche's avatar
Kevin Kirsche committed
159
- 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.
Mark Otto's avatar
Mark Otto committed
160
161
162
163


## Versioning

Tanmay Gupta's avatar
Tanmay Gupta committed
164
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.
Mark Otto's avatar
Mark Otto committed
165

XhmikosR's avatar
XhmikosR committed
166
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.
Mark Otto's avatar
Mark Otto committed
167
168


Chris Rebert's avatar
Chris Rebert committed
169
## Creators
170

Mark Otto's avatar
Mark Otto committed
171
**Mark Otto**
Jacob Thornton's avatar
Jacob Thornton committed
172

173
174
- <https://twitter.com/mdo>
- <https://github.com/mdo>
175

Mark Otto's avatar
Mark Otto committed
176
**Jacob Thornton**
Jacob Thornton's avatar
Jacob Thornton committed
177

178
179
- <https://twitter.com/fat>
- <https://github.com/fat>
Mark Otto's avatar
Mark Otto committed
180

Mark Otto's avatar
Mark Otto committed
181

182
183
## Thanks

XhmikosR's avatar
XhmikosR committed
184
<a href="https://www.browserstack.com/">
Martijn Cuppens's avatar
Martijn Cuppens committed
185
  <img src="https://live.browserstack.com/images/opensource/browserstack-logo.svg" alt="BrowserStack Logo" width="192" height="42">
XhmikosR's avatar
XhmikosR committed
186
</a>
187
188
189

Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers!

XhmikosR's avatar
XhmikosR committed
190

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
## 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/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website)
[![](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website)
[![](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website)
[![](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website)
[![](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website)
[![](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website)
[![](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website)
[![](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website)
[![](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website)
[![](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website)


207
208
209
210
211
212
213
## 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)


Mark Otto's avatar
Mark Otto committed
214
## Copyright and license
Jacob Thornton's avatar
Jacob Thornton committed
215

216
Code and documentation copyright 2011-2019 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/master/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).