gerrit.onap Code Review - vnfsdk/refrepo.git/blob

   1 ---
   2 layout: docs
   3 title: Introduction
   4 description: Get started with Bootstrap, the world's most popular framework for building responsive, mobile-first sites, with BootstrapCDN and a template starter page.
   5 group: getting-started
   6 redirect_from:
   7   - /docs/
   8   - /docs/4.0/
   9   - /docs/4.0/getting-started/
  10   - /docs/getting-started/
  11 toc: true
  12 ---
  13
  14 ## Quick start
  15
  16 Looking to quickly add Bootstrap to your project? Use BootstrapCDN, provided for free by the folks at MaxCDN. Using a package manager or need to download the source files? [Head to the downloads page.]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/download/)
  17
  18 ### CSS
  19
  20 Copy-paste the stylesheet `<link>` into your `<head>` before all other stylesheets to load our CSS.
  21
  22 {% highlight html %}
  23 <link rel="stylesheet" href="{{ site.cdn.css }}" integrity="{{ site.cdn.css_hash }}" crossorigin="anonymous">
  24 {% endhighlight %}
  25
  26 ### JS
  27
  28 Many of our components require the use of JavaScript to function. Specifically, they require [jQuery](https://jquery.com), [Popper.js](https://popper.js.org/), and our own JavaScript plugins. Place the following `<script>`s near the end of your pages, right before the closing `</body>` tag, to enable them. jQuery must come first, then Popper.js, and then our JavaScript plugins.
  29
  30 We use [jQuery's slim build](https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/), but the full version is also supported.
  31
  32 {% highlight html %}
  33 <script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
  34 <script src="{{ site.cdn.popper }}" integrity="{{ site.cdn.popper_hash }}" crossorigin="anonymous"></script>
  35 <script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
  36 {% endhighlight %}
  37
  38 Curious which components explicitly require jQuery, our JS, and Popper.js? Click the show components link below. If you're at all unsure about the general page structure, keep reading for an example page template.
  39
  40 <details>
  41 <summary class="text-primary mb-3">Show components requiring JavaScript</summary>
  42 {% markdown %}
  43 - Alerts for dismissing
  44 - Buttons for toggling states and checkbox/radio functionality
  45 - Carousel for all slide behaviors, controls, and indicators
  46 - Collapse for toggling visibility of content
  47 - Dropdowns for displaying and positioning (also requires [Popper.js](https://popper.js.org/))
  48 - Modals for displaying, positioning, and scroll behavior
  49 - Navbar for extending our Collapse plugin to implement responsive behavior
  50 - Tooltips and popovers for displaying and positioning (also requires [Popper.js](https://popper.js.org/))
  51 - Scrollspy for scroll behavior and navigation updates
  52 {% endmarkdown %}
  53 </details>
  54
  55 ## Starter template
  56
  57 Be sure to have your pages set up with the latest design and development standards. That means using an HTML5 doctype and including a viewport meta tag for proper responsive behaviors. Put it all together and your pages should look like this:
  58
  59 {% highlight html %}
  60 <!doctype html>
  61 <html lang="en">
  62   <head>
  63     <!-- Required meta tags -->
  64     <meta charset="utf-8">
  65     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  66
  67     <!-- Bootstrap CSS -->
  68     <link rel="stylesheet" href="{{ site.cdn.css }}" integrity="{{ site.cdn.css_hash }}" crossorigin="anonymous">
  69
  70     <title>Hello, world!</title>
  71   </head>
  72   <body>
  73     <h1>Hello, world!</h1>
  74
  75     <!-- Optional JavaScript -->
  76     <!-- jQuery first, then Popper.js, then Bootstrap JS -->
  77     <script src="{{ site.cdn.jquery }}" integrity="{{ site.cdn.jquery_hash }}" crossorigin="anonymous"></script>
  78     <script src="{{ site.cdn.popper }}" integrity="{{ site.cdn.popper_hash }}" crossorigin="anonymous"></script>
  79     <script src="{{ site.cdn.js }}" integrity="{{ site.cdn.js_hash }}" crossorigin="anonymous"></script>
  80   </body>
  81 </html>
  82 {% endhighlight %}
  83
  84 That's all you need for overall page requirements. Visit the [Layout docs]({{ site.baseurl }}/docs/{{ site.docs_version }}/layout/overview/) or [our official examples]({{ site.baseurl }}/docs/{{ site.docs_version }}/examples/) to start laying out your site's content and components.
  85
  86 ## Important globals
  87
  88 Bootstrap employs a handful of important global styles and settings that you'll need to be aware of when using it, all of which are almost exclusively geared towards the *normalization* of cross browser styles. Let's dive in.
  89
  90 ### HTML5 doctype
  91
  92 Bootstrap requires the use of the HTML5 doctype. Without it, you'll see some funky incomplete styling, but including it shouldn't cause any considerable hiccups.
  93
  94 {% highlight html %}
  95 <!doctype html>
  96 <html lang="en">
  97   ...
  98 </html>
  99 {% endhighlight %}
 100
 101 ### Responsive meta tag
 102
 103 Bootstrap is developed *mobile first*, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, **add the responsive viewport meta tag** to your `<head>`.
 104
 105 {% highlight html %}
 106 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 107 {% endhighlight %}
 108
 109 You can see an example of this in action in the [starter template](#starter-template).
 110
 111 ### Box-sizing
 112
 113 For more straightforward sizing in CSS, we switch the global `box-sizing` value from `content-box` to `border-box`. This ensures `padding` does not affect the final computed width of an element, but it can cause problems with some third party software like Google Maps and Google Custom Search Engine.
 114
 115 On the rare occasion you need to override it, use something like the following:
 116
 117 {% highlight css %}
 118 .selector-for-some-widget {
 119   box-sizing: content-box;
 120 }
 121 {% endhighlight %}
 122
 123 With the above snippet, nested elements—including generated content via `::before` and `::after`—will all inherit the specified `box-sizing` for that `.selector-for-some-widget`.
 124
 125 Learn more about [box model and sizing at CSS Tricks](https://css-tricks.com/box-sizing/).
 126
 127 ### Reboot
 128
 129 For improved cross-browser rendering, we use [Reboot]({{ site.baseurl }}/docs/{{ site.docs_version }}/content/reboot/) to correct inconsistencies across browsers and devices while providing slightly more opinionated resets to common HTML elements.
 130
 131 ## Community
 132
 133 Stay up to date on the development of Bootstrap and reach out to the community with these helpful resources.
 134
 135 - Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
 136 - Read and subscribe to [The Official Bootstrap Blog]({{ site.blog }}).
 137 - Join [the official Slack room]({{ site.slack }}).
 138 - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
 139 - Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
 140 - 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.
 141
 142 You can also follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap) for the latest gossip and awesome music videos.