mirror of
https://github.com/twbs/bootstrap.git
synced 2022-11-09 12:25:43 -05:00
158 lines
8.1 KiB
Markdown
158 lines
8.1 KiB
Markdown
<p align="center">
|
|
<a href="https://v4-alpha.getbootstrap.com">
|
|
<img src="http://v4-alpha.getbootstrap.com/assets/brand/bootstrap-solid.svg" width=72 height=72>
|
|
</a>
|
|
|
|
<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://v4-alpha.getbootstrap.com"><strong>Explore Bootstrap docs »</strong></a>
|
|
<br>
|
|
<br>
|
|
<a href="https://themes.getbootstrap.com">Bootstrap Themes</a>
|
|
·
|
|
<a href="https://jobs.getbootstrap.com">Job Board</a>
|
|
·
|
|
<a href="https://blog.getbootstrap.com">Blog</a>
|
|
</p>
|
|
</p>
|
|
|
|
<br>
|
|
|
|
## 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)
|
|
- [Copyright and license](#copyright-and-license)
|
|
|
|
## Quick start
|
|
|
|
Several quick start options are available:
|
|
|
|
- [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.0.0-alpha.6.zip)
|
|
- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
|
|
- Install with [npm](https://www.npmjs.com): `npm install bootstrap@4.0.0-alpha.6`
|
|
- Install with [yarn](https://github.com/yarnpkg/yarn): `yarn add bootstrap@4.0.0-alpha.6`
|
|
- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap:4.0.0-alpha.6`
|
|
- Install with [Bower](https://bower.io): `bower install bootstrap#v4.0.0-alpha.6`
|
|
- Install with [NuGet](https://www.nuget.org): CSS: `Install-Package bootstrap -Pre` Sass: `Install-Package bootstrap.sass -Pre` (`-Pre` is only required until Bootstrap v4 has a stable release).
|
|
|
|
Read the [Getting started page](https://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
|
|
|
|
## Status
|
|
|
|
[](https://bootstrap-slack.herokuapp.com)
|
|
[](https://bower.io/search/?q=bootstrap)
|
|
[](https://www.npmjs.com/package/bootstrap)
|
|
[](https://rubygems.org/gems/bootstrap)
|
|
[](https://travis-ci.org/twbs/bootstrap)
|
|
[](https://david-dm.org/twbs/bootstrap?type=dev)
|
|
[](https://atmospherejs.com/twbs/bootstrap)
|
|
[](https://packagist.org/packages/twbs/bootstrap)
|
|
[](https://www.nuget.org/packages/bootstrap/absoluteLatest)
|
|
|
|
[](https://saucelabs.com/u/bootstrap)
|
|
|
|
## 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:
|
|
|
|
```
|
|
bootstrap/
|
|
├── css/
|
|
│ ├── bootstrap.css
|
|
│ ├── bootstrap.css.map
|
|
│ ├── bootstrap.min.css
|
|
│ └── bootstrap.min.css.map
|
|
└── js/
|
|
├── bootstrap.js
|
|
└── bootstrap.min.js
|
|
```
|
|
|
|
We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developers.google.com/web/tools/chrome-devtools/debug/readability/source-maps) (`bootstrap.*.map`) are available for use with certain browsers' developer tools.
|
|
|
|
|
|
## Bugs and feature requests
|
|
|
|
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/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 [Jekyll](https://jekyllrb.com) 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://community.algolia.com/docsearch/). Working on our search? Be sure to set `debug: true` in the `_scripts.html` include.
|
|
|
|
### Running documentation locally
|
|
|
|
1. Run through the [tooling setup](https://github.com/twbs/bootstrap/blob/v4-dev/docs/4.0/getting-started/build-tools.md#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
|
|
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 `bundle exec jekyll serve` in the command line.
|
|
4. Open <http://localhost:9001> in your browser, and voilà.
|
|
|
|
Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/home/).
|
|
|
|
### Documentation for previous releases
|
|
|
|
Documentation for v2.3.2 has been made available for the time being at <https://getbootstrap.com/2.3.2/> while folks transition to Bootstrap 3.
|
|
|
|
[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/master/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/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).
|
|
|
|
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 <http://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-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
|
|
- 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](http://semver.org/). Sometimes we screw up, but we'll 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>
|
|
|
|
|
|
|
|
## Copyright and license
|
|
|
|
Code and documentation copyright 2011-2017 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://github.com/twbs/bootstrap/blob/master/docs/LICENSE).
|