twbs--bootstrap/README.md

Bootstrap

Sleek, intuitive, and powerful front-end framework for faster and easier web development.
Visit Bootstrap »

Table of contents

• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Creators
• Copyright and license

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@4.0.0-alpha.6
• Install with yarn: yarn add bootstrap@4.0.0-alpha.6
• Install with Composer: composer require twbs/bootstrap:4.0.0-alpha.6
• Install with Bower: bower install bootstrap#v4.0.0-alpha.6
• Install with NuGet: 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 for information on the framework contents, templates and examples, and more.

Status

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 (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 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 Jekyll and publicly hosted on GitHub Pages at https://getbootstrap.com. The docs may also be run locally.

Running documentation locally

1. Run through the 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.

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

Community

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

• Follow @getbootstrap on Twitter.
• Read and subscribe to The Official Bootstrap Blog.
• Join the official Slack room.
• 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).
• Developers should use the keyword bootstrap on packages which modify or add to the functionality of Bootstrap when distributing through npm 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. Sometimes we screw up, but we'll 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

• 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 and Twitter, Inc. Code released under the MIT License. Docs released under Creative Commons.