OSDN Git Service

cd01c6609d5ee1665d20462ffd69081b102b2923
[bytom/vapor.git] / tools / side_chain_tool / web / node_modules / bootstrap / README.md
1 <p align="center">
2   <a href="https://getbootstrap.com/">
3     <img src="https://getbootstrap.com/docs/4.1/assets/brand/bootstrap-solid.svg" alt="Bootstrap logo" width=72 height=72>
4   </a>
5
6   <h3 align="center">Bootstrap</h3>
7
8   <p align="center">
9     Sleek, intuitive, and powerful front-end framework for faster and easier web development.
10     <br>
11     <a href="https://getbootstrap.com/docs/4.1/"><strong>Explore Bootstrap docs »</strong></a>
12     <br>
13     <br>
14     <a href="https://github.com/twbs/bootstrap/issues/new?template=bug.md">Report bug</a>
15     ·
16     <a href="https://github.com/twbs/bootstrap/issues/new?template=feature.md&labels=feature">Request feature</a>
17     ·
18     <a href="https://themes.getbootstrap.com/">Themes</a>
19     ·
20     <a href="https://jobs.getbootstrap.com/">Jobs</a>
21     ·
22     <a href="https://blog.getbootstrap.com/">Blog</a>
23   </p>
24 </p>
25
26 <br>
27
28 ## Table of contents
29
30 - [Quick start](#quick-start)
31 - [Status](#status)
32 - [What's included](#whats-included)
33 - [Bugs and feature requests](#bugs-and-feature-requests)
34 - [Documentation](#documentation)
35 - [Contributing](#contributing)
36 - [Community](#community)
37 - [Versioning](#versioning)
38 - [Creators](#creators)
39 - [Copyright and license](#copyright-and-license)
40
41 ## Quick start
42
43 Several quick start options are available:
44
45 - [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.1.3.zip)
46 - Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
47 - Install with [npm](https://www.npmjs.com/): `npm install bootstrap`
48 - Install with [yarn](https://yarnpkg.com/): `yarn add bootstrap@4.1.3`
49 - Install with [Composer](https://getcomposer.org/): `composer require twbs/bootstrap:4.1.3`
50 - Install with [NuGet](https://www.nuget.org/): CSS: `Install-Package bootstrap` Sass: `Install-Package bootstrap.sass`
51
52 Read the [Getting started page](https://getbootstrap.com/docs/4.1/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
53
54 ## Status
55
56 [![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com/)
57 [![Build Status](https://img.shields.io/travis/twbs/bootstrap/v4-dev.svg)](https://travis-ci.org/twbs/bootstrap)
58 [![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap)
59 [![Gem version](https://img.shields.io/gem/v/bootstrap.svg)](https://rubygems.org/gems/bootstrap)
60 [![Meteor Atmosphere](https://img.shields.io/badge/meteor-twbs%3Abootstrap-blue.svg)](https://atmospherejs.com/twbs/bootstrap)
61 [![Packagist Prerelease](https://img.shields.io/packagist/vpre/twbs/bootstrap.svg)](https://packagist.org/packages/twbs/bootstrap)
62 [![NuGet](https://img.shields.io/nuget/vpre/bootstrap.svg)](https://www.nuget.org/packages/bootstrap/absoluteLatest)
63 [![peerDependencies Status](https://img.shields.io/david/peer/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=peer)
64 [![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=dev)
65 [![Coverage Status](https://img.shields.io/coveralls/github/twbs/bootstrap/v4-dev.svg)](https://coveralls.io/github/twbs/bootstrap?branch=v4-dev)
66 [![CSS gzip size](http://img.badgesize.io/twbs/bootstrap/v4-dev/dist/css/bootstrap.min.css?compression=gzip&label=CSS+gzip+size)](https://github.com/twbs/bootstrap/tree/v4-dev/dist/css/bootstrap.min.css)
67 [![JS gzip size](http://img.badgesize.io/twbs/bootstrap/v4-dev/dist/js/bootstrap.min.js?compression=gzip&label=JS+gzip+size)](https://github.com/twbs/bootstrap/tree/v4-dev/dist/js/bootstrap.min.js)
68
69 [![Sauce Labs Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
70
71 ## What's included
72
73 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:
74
75 ```
76 bootstrap/
77 └── dist/
78     ├── css/
79     │   ├── bootstrap-grid.css
80     │   ├── bootstrap-grid.css.map
81     │   ├── bootstrap-grid.min.css
82     │   ├── bootstrap-grid.min.css.map
83     │   ├── bootstrap-reboot.css
84     │   ├── bootstrap-reboot.css.map
85     │   ├── bootstrap-reboot.min.css
86     │   ├── bootstrap-reboot.min.css.map
87     │   ├── bootstrap.css
88     │   ├── bootstrap.css.map
89     │   ├── bootstrap.min.css
90     │   └── bootstrap.min.css.map
91     └── js/
92         ├── bootstrap.bundle.js
93         ├── bootstrap.bundle.js.map
94         ├── bootstrap.bundle.min.js
95         ├── bootstrap.bundle.min.js.map
96         ├── bootstrap.js
97         ├── bootstrap.js.map
98         ├── bootstrap.min.js
99         └── bootstrap.min.js.map
100 ```
101
102 We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). [source maps](https://developers.google.com/web/tools/chrome-devtools/debug/readability/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](https://popper.js.org/), but not [jQuery](https://jquery.com/).
103
104
105 ## Bugs and feature requests
106
107 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).
108
109
110 ## Documentation
111
112 Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages at <https://getbootstrap.com/>. The docs may also be run locally.
113
114 Documentation search is powered by [Algolia's DocSearch](https://community.algolia.com/docsearch/). Working on our search? Be sure to set `debug: true` in `site/docs/4.1/assets/js/src/search.js` file.
115
116 ### Running documentation locally
117
118 1. Run through the [tooling setup](https://getbootstrap.com/docs/4.1/getting-started/build-tools/#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
119 2. Run `npm install` to install Node.js dependencies.
120 3. Run `npm start` to compile CSS and JavaScript files, generate our docs, and watch for changes.
121 4. Open `http://localhost:9001` in your browser, and voilà.
122
123 Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/home/).
124
125 ### Documentation for previous releases
126
127 - For v2.3.2: <https://getbootstrap.com/2.3.2/>
128 - For v3.3.x: <https://getbootstrap.com/docs/3.3/>
129 - For v4.0.x: <https://getbootstrap.com/docs/4.0/>
130
131 [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
132
133
134 ## Contributing
135
136 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.
137
138 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).
139
140 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 <https://editorconfig.org/>.
141
142
143 ## Community
144
145 Get updates on Bootstrap's development and chat with the project maintainers and community members.
146
147 - Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
148 - Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com/).
149 - Join [the official Slack room](https://bootstrap-slack.herokuapp.com/).
150 - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
151 - Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
152 - 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.
153
154
155 ## Versioning
156
157 For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](https://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible.
158
159 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](https://blog.getbootstrap.com/) contain summaries of the most noteworthy changes made in each release.
160
161
162 ## Creators
163
164 **Mark Otto**
165
166 - <https://twitter.com/mdo>
167 - <https://github.com/mdo>
168
169 **Jacob Thornton**
170
171 - <https://twitter.com/fat>
172 - <https://github.com/fat>
173
174
175 ## Copyright and license
176
177 Code and documentation copyright 2011-2018 the [Bootstrap Authors](https://github.com/twbs/bootstrap/graphs/contributors) and [Twitter, Inc.](https://twitter.com) 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).