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.

README.md 6.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. # [Bootstrap](http://getbootstrap.com)
  2. ![Bower version](https://img.shields.io/bower/v/bootstrap.svg?style=flat)
  3. [![npm version](https://img.shields.io/npm/v/bootstrap.svg?style=flat)](https://www.npmjs.com/package/bootstrap)
  4. [![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg?style=flat)](https://travis-ci.org/twbs/bootstrap)
  5. [![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg?style=flat)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
  6. [![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
  7. 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.
  8. To get started, check out <http://getbootstrap.com>!
  9. ## Table of contents
  10. - [Quick start](#quick-start)
  11. - [Bugs and feature requests](#bugs-and-feature-requests)
  12. - [Documentation](#documentation)
  13. - [Contributing](#contributing)
  14. - [Community](#community)
  15. - [Versioning](#versioning)
  16. - [Creators](#creators)
  17. - [Copyright and license](#copyright-and-license)
  18. ## Quick start
  19. Four quick start options are available:
  20. - [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.2.zip).
  21. - Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
  22. - Install with [Bower](http://bower.io): `bower install bootstrap`.
  23. - Install with [npm](https://www.npmjs.org): `npm install bootstrap`.
  24. Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
  25. ### What's included
  26. 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:
  27. ```
  28. bootstrap/
  29. ├── css/
  30. │ ├── bootstrap.css
  31. │ ├── bootstrap.css.map
  32. │ ├── bootstrap.min.css
  33. │ ├── bootstrap-theme.css
  34. │ ├── bootstrap-theme.css.map
  35. │ └── bootstrap-theme.min.css
  36. ├── js/
  37. │ ├── bootstrap.js
  38. │ └── bootstrap.min.js
  39. └── fonts/
  40. ├── glyphicons-halflings-regular.eot
  41. ├── glyphicons-halflings-regular.svg
  42. ├── glyphicons-halflings-regular.ttf
  43. ├── glyphicons-halflings-regular.woff
  44. └── glyphicons-halflings-regular.woff2
  45. ```
  46. 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/chrome-developer-tools/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.
  47. ## Bugs and feature requests
  48. 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).
  49. ## Documentation
  50. 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.
  51. ### Running documentation locally
  52. 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x).
  53. - **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
  54. 2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`.
  55. 3. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
  56. 4. Open <http://localhost:9001> in your browser, and voilà.
  57. Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
  58. ### Documentation for previous releases
  59. 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.
  60. [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
  61. ## Contributing
  62. 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.
  63. 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](https://github.com/mdo/code-guide), maintained by [Mark Otto](https://github.com/mdo).
  64. 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>.
  65. ## Community
  66. Keep track of development and community news.
  67. - Follow [@twbootstrap on Twitter](https://twitter.com/twbootstrap).
  68. - Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
  69. - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
  70. - Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
  71. ## Versioning
  72. 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.
  73. ## Creators
  74. **Mark Otto**
  75. - <https://twitter.com/mdo>
  76. - <https://github.com/mdo>
  77. **Jacob Thornton**
  78. - <https://twitter.com/fat>
  79. - <https://github.com/fat>
  80. ## Copyright and license
  81. Code and documentation copyright 2011-2015 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).