You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

142 lines
7.9 KiB

4 years ago
  1. # [Bootstrap](http://getbootstrap.com)
  2. [![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com)
  3. ![Bower version](https://img.shields.io/bower/v/bootstrap.svg)
  4. [![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap)
  5. [![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg)](https://travis-ci.org/twbs/bootstrap)
  6. [![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
  7. [![NuGet](https://img.shields.io/nuget/v/bootstrap.svg)](https://www.nuget.org/packages/Bootstrap)
  8. [![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
  9. Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by [Mark Otto](https://twitter.com/mdo) and [Jacob Thornton](https://twitter.com/fat), and maintained by the [core team](https://github.com/orgs/twbs/people) with the massive support and involvement of the community.
  10. To get started, check out <http://getbootstrap.com>!
  11. ## Table of contents
  12. * [Quick start](#quick-start)
  13. * [Bugs and feature requests](#bugs-and-feature-requests)
  14. * [Documentation](#documentation)
  15. * [Contributing](#contributing)
  16. * [Community](#community)
  17. * [Versioning](#versioning)
  18. * [Creators](#creators)
  19. * [Copyright and license](#copyright-and-license)
  20. ## Quick start
  21. Several quick start options are available:
  22. * [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.7.zip).
  23. * Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
  24. * Install with [Bower](http://bower.io): `bower install bootstrap`.
  25. * Install with [npm](https://www.npmjs.com): `npm install bootstrap@3`.
  26. * Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`.
  27. * Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`.
  28. Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
  29. ### What's included
  30. 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:
  31. ```
  32. bootstrap/
  33. ├── css/
  34. │ ├── bootstrap.css
  35. │ ├── bootstrap.css.map
  36. │ ├── bootstrap.min.css
  37. │ ├── bootstrap.min.css.map
  38. │ ├── bootstrap-theme.css
  39. │ ├── bootstrap-theme.css.map
  40. │ ├── bootstrap-theme.min.css
  41. │ └── bootstrap-theme.min.css.map
  42. ├── js/
  43. │ ├── bootstrap.js
  44. │ └── bootstrap.min.js
  45. └── fonts/
  46. ├── glyphicons-halflings-regular.eot
  47. ├── glyphicons-halflings-regular.svg
  48. ├── glyphicons-halflings-regular.ttf
  49. ├── glyphicons-halflings-regular.woff
  50. └── glyphicons-halflings-regular.woff2
  51. ```
  52. We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developer.chrome.com/devtools/docs/css-preprocessors) (`bootstrap.*.map`) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.
  53. ## Bugs and feature requests
  54. 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).
  55. Note that **feature requests must target [Bootstrap v4](https://github.com/twbs/bootstrap/tree/v4-dev),** because Bootstrap v3 is now in maintenance mode and is closed off to new features. This is so that we can focus our efforts on Bootstrap v4.
  56. ## Documentation
  57. Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <http://getbootstrap.com>. The docs may also be run locally.
  58. ### Running documentation locally
  59. 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) and other Ruby dependencies with `bundle install`.
  60. **Note for Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
  61. 2. From the root `/bootstrap` directory, run `bundle exec jekyll serve` in the command line.
  62. 4. Open `http://localhost:9001` in your browser, and voilà.
  63. Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
  64. ### Documentation for previous releases
  65. 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.
  66. [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
  67. ## Contributing
  68. 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.
  69. 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).
  70. **Bootstrap v3 is now closed off to new features.** It has gone into maintenance mode so that we can focus our efforts on [Bootstrap v4](https://github.com/twbs/bootstrap/tree/v4-dev), the future of the framework. Pull requests which add new features (rather than fix bugs) should target [Bootstrap v4 (the `v4-dev` git branch)](https://github.com/twbs/bootstrap/tree/v4-dev) instead.
  71. 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>.
  72. ## Community
  73. Get updates on Bootstrap's development and chat with the project maintainers and community members.
  74. * Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
  75. * Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
  76. * Join [the official Slack room](https://bootstrap-slack.herokuapp.com).
  77. * Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
  78. * Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](https://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
  79. * 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.
  80. ## Versioning
  81. 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.
  82. 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](http://blog.getbootstrap.com) contain summaries of the most noteworthy changes made in each release.
  83. ## Creators
  84. **Mark Otto**
  85. * <https://twitter.com/mdo>
  86. * <https://github.com/mdo>
  87. **Jacob Thornton**
  88. * <https://twitter.com/fat>
  89. * <https://github.com/fat>
  90. ## Copyright and license
  91. Code and documentation copyright 2011-2016 Twitter, Inc. 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).