0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00
The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web. http://getbootstrap.com
Go to file
Chris Rebert ead5ed6d73 Fix docs asset file paths in /grunt/configBridge.json (#20178)
Previously, when running the docs locally, the site, rooted at:
    http://localhost:9001/
would reference docs assets using relative URLs such as:
    /../assets/js/vendor/anchor.min.js
which is equivalent to:
    http://localhost:9001/../assets/js/vendor/anchor.min.js
which is nonsense, since the root directory has no parent directory.
Apparently browsers silently ignore this extra '..', hence why this wasn't noticed until now.
But if you adjust Jekyll's `baseurl` setting, this mistake causes incorrect URLs to get generated.

This commit corrects the problem by removing the extra '../' from the paths.

These paths are also referenced in the Gruntfile, where the fix actually allows us to simplify the code.
Previously, in the Gruntfile, we were doing, e.g.:
    path.join('./docs/assets', '../assets/js/vendor/anchor.min.js')
which calculates to:
    ./docs/assets/../assets/js/vendor/anchor.min.js
which can be simplified to:
    ./docs/assets/js/vendor/anchor.min.js
So we can remove the '/assets' suffix from the left argument
and the '../' prefix from the right argument
and still obtain the same result.
2016-06-26 16:42:13 -07:00
dist grunt dist docs 2016-06-26 16:13:28 -07:00
docs grunt dist docs 2016-06-26 16:13:28 -07:00
grunt Fix docs asset file paths in /grunt/configBridge.json (#20178) 2016-06-26 16:42:13 -07:00
js Merge branch 'v4-dev' of https://github.com/twbs/bootstrap into v4-dev 2016-06-12 21:17:14 -07:00
nuget Add "The Bootstrap Authors" to copyright notices (#19936) 2016-05-20 09:04:31 -07:00
scss Replace grunt-postcss with postcss-cli (#20140) 2016-06-20 16:18:21 -07:00
_config.yml Update jQuery to v2.2.4. 2016-05-26 15:26:12 +03:00
.editorconfig Update README.md. 2015-07-26 00:29:29 +03:00
.gitattributes Remove dropped v3 bootstrap-theme 2015-09-08 08:58:03 +03:00
.gitignore Update to Jekyll v3.0.0. 2015-10-29 08:12:33 +02:00
.hound.yml Upgrade ESLint to v1.10.3 2016-05-31 00:12:17 -07:00
.travis.yml Travis: Upgrade Node.js from v5 to v6 (#19980) 2016-05-28 13:39:40 -07:00
bower.json Add tether as bower dependency 2015-12-15 12:56:33 -08:00
CHANGELOG.md Add changelog file that points to GitHub Releases & our blog 2015-07-01 15:36:06 -07:00
CNAME custom cname for v4 alpha 2015-08-18 22:47:18 -07:00
composer.json remove less references from package files 2015-01-18 19:06:51 -08:00
CONTRIBUTING.md Fix links to A11Y Project posts 2016-06-23 23:15:38 -07:00
Gemfile Bump jekyll-redirect-from. 2016-03-17 09:12:27 +02:00
Gemfile.lock Bump gems. 2016-05-26 15:31:55 +03:00
Gruntfile.js Fix docs asset file paths in /grunt/configBridge.json (#20178) 2016-06-26 16:42:13 -07:00
ISSUE_TEMPLATE.md ISSUE_TEMPLATE.md: Fix "questons" typo 2016-06-05 15:01:09 -07:00
LICENSE Add "The Bootstrap Authors" to copyright notices (#19936) 2016-05-20 09:04:31 -07:00
package.js Update version numbers using npm script 2015-12-08 18:16:47 -08:00
package.json Replace grunt-postcss with postcss-cli (#20140) 2016-06-20 16:18:21 -07:00
README.md Add "The Bootstrap Authors" to copyright notices (#19936) 2016-05-20 09:04:31 -07:00
sache.json Add sache.json 2014-12-15 11:06:10 -08:00

Bootstrap

Slack Bower version npm version Gem version Build Status devDependency Status Meteor Atmosphere Packagist Prerelease NuGet Selenium Test Status

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.

To get started, check out http://getbootstrap.com!

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@4.0.0-alpha.2
  • Install with Meteor: meteor add twbs:bootstrap@=4.0.0-alpha.2
  • Install with Composer: composer require twbs/bootstrap
  • Install with Bower: bower install bootstrap#v4.0.0-alpha.2
  • 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.

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 http://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 grunt (or a specific set of Grunt tasks) 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 http://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

Jacob Thornton

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