Skip to content
Documentation for the UnderStrap starter theme project.
HTML CSS JavaScript Other
Branch: master
Clone or download
Latest commit 4b7cbbc Aug 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Initial commit Apr 25, 2018
.vscode Fixing linting issues.. May 12, 2018
_data Trying to complete as much of the docs as possible for first release … May 14, 2018
_gh_pages trying to resolve merge conflict May 19, 2018
_includes Preparing github-pages release May 16, 2018
_layouts
assets Trying to get Service-Worker to work.. May 17, 2018
build .. May 17, 2018
dist
docs/0.8.2
js
nuget
scss Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
.babelrc.js Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
.editorconfig Initial commit Apr 25, 2018
.eslintignore Initial commit Apr 25, 2018
.eslintrc.json
.gitattributes
.gitignore More small changes... May 16, 2018
.stylelintignore Initial commit Apr 25, 2018
.stylelintrc
.travis.yml Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
CNAME
CODE_OF_CONDUCT.md
Gemfile Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
Gemfile.lock
LICENSE.md Content additions, fixes, cleanup May 14, 2018
README.md Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
_config.yml Updating integrity hash May 17, 2018
composer.json Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
favicon.ico Initial commit Apr 25, 2018
index.html
package.js Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018
package.json
robots.txt Initial commit Apr 25, 2018
sache.json Initial commit Apr 25, 2018
sw.js Updating to BS 4.0.1, adding new content, complete rewrite May 13, 2018

README.md

Bootstrap

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

Report bug · Request feature · Themes · Jobs · Blog


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
  • Install with yarn: yarn add bootstrap@4.1.1
  • Install with Composer: composer require twbs/bootstrap:4.1.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 and examples, and more.

Status

Slack Build Status npm version Gem version Meteor Atmosphere Packagist Prerelease NuGet peerDependencies Status devDependency Status CSS gzip size JS gzip size

Sauce Labs Test 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
│   ├── 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
└── js/
    ├── bootstrap.bundle.js
    ├── bootstrap.bundle.min.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. Bundled JS files (bootstrap.bundle.js and minified bootstrap.bundle.min.js) include Popper, but not jQuery.

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.

Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set debug: true in assets/js/src/search.js file.

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 install to install Node.js dependencies.
  3. Run npm run test (or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
  4. From the root /bootstrap directory, run npm run docs-serve in the command line.
  5. Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

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

Jacob Thornton

Copyright and license

Code and documentation copyright 2011-2018 the Bootstrap Authors and Twitter, Inc. Code released under the MIT License. Docs released under Creative Commons.

You can’t perform that action at this time.