diff options
| author | Mark Otto <markotto@twitter.com> | 2012-07-08 12:47:36 +0400 |
|---|---|---|
| committer | Mark Otto <markotto@twitter.com> | 2012-07-08 12:47:36 +0400 |
| commit | 20676ddd4d3e46c9fb32aadfeddb3a4a68efa6a3 (patch) | |
| tree | bacc672697292c0b83f5b44b014a3321e2d2195e /docs | |
| parent | 5f861ef51735d8b0f2c0f0faf8f438808a480d99 (diff) | |
adding getting started page based on Bootstrap University from awhile back, testing out side nav on docs instead of subnav bar
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/assets/css/bootstrap.css | 3 | ||||
| -rw-r--r-- | docs/assets/css/docs.css | 84 | ||||
| -rw-r--r-- | docs/base-css.html | 18 | ||||
| -rw-r--r-- | docs/components.html | 32 | ||||
| -rw-r--r-- | docs/download.html | 2 | ||||
| -rw-r--r-- | docs/examples.html | 2 | ||||
| -rw-r--r-- | docs/extend.html | 2 | ||||
| -rw-r--r-- | docs/getting-started.html | 255 | ||||
| -rw-r--r-- | docs/index.html | 4 | ||||
| -rw-r--r-- | docs/javascript.html | 25 | ||||
| -rw-r--r-- | docs/scaffolding.html | 18 | ||||
| -rw-r--r-- | docs/templates/layout.mustache | 2 | ||||
| -rw-r--r-- | docs/templates/pages/base-css.mustache | 17 | ||||
| -rw-r--r-- | docs/templates/pages/components.mustache | 30 | ||||
| -rw-r--r-- | docs/templates/pages/getting-started.mustache | 143 | ||||
| -rw-r--r-- | docs/templates/pages/index.mustache | 2 | ||||
| -rw-r--r-- | docs/templates/pages/javascript.mustache | 24 | ||||
| -rw-r--r-- | docs/templates/pages/scaffolding.mustache | 17 | ||||
| -rw-r--r-- | docs/upgrading.html | 2 |
19 files changed, 654 insertions, 28 deletions
diff --git a/docs/assets/css/bootstrap.css b/docs/assets/css/bootstrap.css index d24c6f36a3..6e2ab728cd 100644 --- a/docs/assets/css/bootstrap.css +++ b/docs/assets/css/bootstrap.css @@ -631,7 +631,8 @@ h4 small { } .page-header { - margin: 20px 0 19px; + padding-bottom: 9px; + margin: 20px 0 30px; border-bottom: 1px solid #eeeeee; } diff --git a/docs/assets/css/docs.css b/docs/assets/css/docs.css index a8398ca4d1..e84d118d1f 100644 --- a/docs/assets/css/docs.css +++ b/docs/assets/css/docs.css @@ -12,7 +12,7 @@ body { position: relative; - padding-top: 100px; + padding-top: 80px; font-size: 14px; background-color: #fff; background-image: url(../img/grid-20px.png); @@ -20,12 +20,6 @@ body { background-position: 0 40px; } -/* Custom container for the narrow docs */ -.bs-docs-container { - max-width: 780px; - margin: 0 auto; -} - /* Code in headings */ h3 code { font-size: 14px; @@ -37,6 +31,10 @@ h3 code { /* Tweak navbar brand link to be super sleek -------------------------------------------------- */ +body > .navbar-fixed-top { + font-size: 13px; +} + /* Change the docs' brand */ body > .navbar-fixed-top .brand { padding-right: 0; @@ -52,6 +50,7 @@ body > .navbar-fixed-top .brand { } body > .navbar-fixed-top .brand:hover { text-decoration: none; + text-shadow: 0 1px 0 rgba(255,255,255,.1), 0 0 30px rgba(255,255,255,.4); } @@ -119,7 +118,7 @@ hr.soften { ------------------------- */ .masthead { padding: 50px 0 60px; - margin-top: -60px; + margin-top: -40px; margin-bottom: 0; color: #fff; text-align: center; @@ -207,10 +206,14 @@ hr.soften { ------------------------- */ .subhead { text-align: left; + border-bottom: 1px solid #ddd; } .subhead h1 { font-size: 60px; } +.subhead .navbar { + display: none; +} @@ -242,7 +245,7 @@ hr.soften { } .marketing img { display: block; - margin: 0 auto 20px; + margin: 0 auto 30px; } @@ -837,3 +840,66 @@ form.bs-docs-example { float: none; } } + + + +/* Docs side .nav-list +------------------------- */ +.span3 { + min-height: 1px; +} +.bs-docs-sidenav { + margin-top: 40px; + padding: 0; + margin-right: 10px; + background-color: #fff; + border: 1px solid #e5e5e5; + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; +} +.bs-docs-sidenav > li > a { + margin: 0; + font-size: 14px; + padding: 9px 14px; + border-top: 1px solid #eee; +} +.bs-docs-sidenav > li:first-child > a { + border-top: 0; + -webkit-border-radius: 5px 5px 0 0; + -moz-border-radius: 5px 5px 0 0; + border-radius: 5px 5px 0 0; +} +.bs-docs-sidenav > li:last-child > a { + -webkit-border-radius: 0 0 5px 5px; + -moz-border-radius: 0 0 5px 5px; + border-radius: 0 0 5px 5px; +} +/* Chevrons */ +.bs-docs-sidenav .icon-chevron-right { + float: right; + margin-top: 2px; + margin-right: -6px; + opacity: .25; +} +.bs-docs-sidenav > li > a:hover { + background-color: #f5f5f5; +} +.bs-docs-sidenav a:hover .icon-chevron-right { + opacity: .5; +} +.bs-docs-sidenav .active .icon-chevron-right { + background-image: url(../img/glyphicons-halflings-white.png); + opacity: .75; +} + +@media (max-width: 979px) { + + .bs-docs-sidenav { + margin-top: 30px; + margin-right: 0; + } + +} + + diff --git a/docs/base-css.html b/docs/base-css.html index ed6f27871c..8c2879907d 100644 --- a/docs/base-css.html +++ b/docs/base-css.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> @@ -88,6 +88,20 @@ </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#typography">Typography</a></li> + <li><a href="#code">Code</a></li> + <li><a href="#tables">Tables</a></li> + <li><a href="#forms">Forms</a></li> + <li><a href="#buttons">Buttons</a></li> + <li><a href="#icons">Icons by Glyphicons</a></li> + </ul> + </div> + <div class="span9"> + + <!-- Typography ================================================== --> @@ -1625,6 +1639,8 @@ For example, <code>section</code> should be wrapped as inline. </section> +</div> +</div> <!-- Footer ================================================== --> diff --git a/docs/components.html b/docs/components.html index 9a67b25e0d..2132478217 100644 --- a/docs/components.html +++ b/docs/components.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> @@ -105,13 +105,34 @@ </div> </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#dropdowns">Dropdowns <i class="icon-chevron-right"></i></a></li> + <li><a href="#buttonGroups">Button groups <i class="icon-chevron-right"></i></a></li> + <li><a href="#buttonDropdowns">Button dropdowns <i class="icon-chevron-right"></i></a></li> + <li><a href="#navs">Navs <i class="icon-chevron-right"></i></a></li> + <li><a href="#navbar">Navbar <i class="icon-chevron-right"></i></a></li> + <li><a href="#breadcrumbs">Breadcrumbs <i class="icon-chevron-right"></i></a></li> + <li><a href="#pagination">Pagination <i class="icon-chevron-right"></i></a></li> + <li><a href="#labels">Labels <i class="icon-chevron-right"></i></a></li> + <li><a href="#badges">Badges <i class="icon-chevron-right"></i></a></li> + <li><a href="#typography">Typography <i class="icon-chevron-right"></i></a></li> + <li><a href="#thumbnails">Thumbnails <i class="icon-chevron-right"></i></a></li> + <li><a href="#alerts">Alerts <i class="icon-chevron-right"></i></a></li> + <li><a href="#progress">Progress bars <i class="icon-chevron-right"></i></a></li> + <li><a href="#misc">Misc <i class="icon-chevron-right"></i></a></li> + </ul> + </div> + <div class="span9"> + <!-- Dropdowns ================================================== --> <section id="dropdowns"> <div class="page-header"> - <h1>Dropdown menus <small>Dropdown and dropup menus for contextual actions</small></h1> + <h1>Dropdown menus</h1> </div> <h2>Example</h2> @@ -295,7 +316,7 @@ ================================================== --> <section id="buttonDropdowns"> <div class="page-header"> - <h1>Button dropdown menus <small>Built on button groups to provide contextual menus</small></h1> + <h1>Button dropdown menus</h1> </div> @@ -630,7 +651,7 @@ ================================================== --> <section id="navs"> <div class="page-header"> - <h1>Nav, tabs, and pills <small>Highly customizable list-style navigation</small></h1> + <h1>Nav: tabs, pills, and lists</small></h1> </div> <h2>Lightweight defaults <small>Same markup, different classes</small></h2> @@ -2213,6 +2234,9 @@ class="clearfix" </section> + </div> +</div> + <!-- Footer ================================================== --> diff --git a/docs/download.html b/docs/download.html index 301854a031..9aebb74d23 100644 --- a/docs/download.html +++ b/docs/download.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> diff --git a/docs/examples.html b/docs/examples.html index 1c8434b751..a2c7447b82 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> diff --git a/docs/extend.html b/docs/extend.html index b3b72f75e7..ccd5122602 100644 --- a/docs/extend.html +++ b/docs/extend.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> diff --git a/docs/getting-started.html b/docs/getting-started.html new file mode 100644 index 0000000000..26a9bc38ee --- /dev/null +++ b/docs/getting-started.html @@ -0,0 +1,255 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Getting ยท Twitter Bootstrap</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content=""> + + <!-- Le styles --> + <link href="assets/css/bootstrap.css" rel="stylesheet"> + <link href="assets/css/bootstrap-responsive.css" rel="stylesheet"> + <link href="assets/css/docs.css" rel="stylesheet"> + <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> + <!--[if lt IE 9]> + <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + + <!-- Le fav and touch icons --> + <link rel="shortcut icon" href="assets/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/apple-touch-icon-144-precomposed.png"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/apple-touch-icon-114-precomposed.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="assets/ico/apple-touch-icon-72-precomposed.png"> + <link rel="apple-touch-icon-precomposed" href="assets/ico/apple-touch-icon-57-precomposed.png"> + + </head> + + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> + + <!-- Navbar + ================================================== --> + <div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="brand" href="./index.html">Bootstrap</a> + <div class="nav-collapse collapse"> + <ul class="nav"> + <li class=""> + <a href="./index.html">Home</a> + </li> + <li class=""> + <a href="./scaffolding.html">Scaffolding</a> + </li> + <li class=""> + <a href="./base-css.html">Base CSS</a> + </li> + <li class=""> + <a href="./components.html">Components</a> + </li> + <li class=""> + <a href="./javascript.html">Javascript</a> + </li> + <li class=""> + <a href="./extend.html">Extend</a> + </li> + </ul> + </div> + </div> + </div> + </div> + + <div class="container"> + +<!-- Masthead +================================================== --> +<header class="jumbotron subhead" id="overview"> + <h1>Getting started</h1> + <p class="lead">Overview of the project, it's contents, and how to get started with a simple template.</p> +</header> + +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#prerequisites">Prerequisites <i class="icon-chevron-right"></i></a></li> + <li><a href="#file-structure">File structure <i class="icon-chevron-right"></i></a></li> + <li><a href="#contents">What's included <i class="icon-chevron-right"></i></a></li> + <li><a href="#html-template">HTML template <i class="icon-chevron-right"></i></a></li> + </ul> + </div> + <div class="span9"> + + + <section id="prerequisites"> + <div class="page-header"> + <h1>Prerequisites</h1> + </div> + <p>Before getting started, you need the following:</p> + <ul> + <li>An unzipped copy of the <a href="https://github.com/twitter/bootstrap/zipball/master">latest version of Bootstrap</a> (which includes all CSS, JavaScript, and images).</li> + <li>An editor of your choice for writing code (I recommend <a href="http://sublimetext.com/2">Sublime Text 2</a>).</li> + <li>Some working knowledge of HTML and CSS.</li> + </ul> + <p>When ready, proceed to the next section, <a href="#file-structure">File structure</a>.</p> + </section> + + + + <section id="file-structure"> + <div class="page-header"> + <h1>File structure</h1> + </div> + <p>Once unzipped, the structure of Bootstrap’s files looks like this:</p> + <ul> + <li>bootstrap/ + <ul> + <li>css/ + <ul> + <li>bootstrap.css</li> + <li>bootstrap.min.css</li> + </ul> + </li> + <li>js/ + <ul> + <li>bootstrap.js</li> + <li>bootstrap.min.js</li> + </ul> + </li> + <li>img/ + <ul> + <li>glyphicons-halflings.png</li> + <li>glyphicons-halflings-white.png</li> + </ul> + </li> + <li>README.md</li> + </ul> + </li> + </ul> + <p>This is the most basic form of Bootstrap: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (<code>bootstrap.*</code>), as well as compiled and minified CSS and JS (<code>bootstrap.min.*</code>). The image files are compressed using <a href="http://imageoptim.com/">ImageOptim</a>, a Mac app for compressing PNGs.</p> + </section> + + + + <section id="contents"> + <div class="page-header"> + <h1>What's included</h1> + </div> + <p>Bootstrap comes equipped with CSS for all sorts of things, but they can be summarized with a handful of categories visible at the top of the <a href="http://getbootstrap.com">Bootstrap documentation</a>:</p> + <ul> + <li><strong><a href="http://twitter.github.com/bootstrap/scaffolding.html">Scaffolding:</a></strong> Global styles for the body to reset type and background, link styles, grid system, and two simple layouts.</li> + <li><strong><a href="http://twitter.github.com/bootstrap/base-css.html">Base CSS:</a></strong> Styles for common HTML elements like typography, code, tables, forms, and buttons. Also includes <a href="http://glyphicons.com">Glyphicons</a>, a great little icon set.</li> + <li><strong><a href="http://twitter.github.com/bootstrap/components.html">Components:</a></strong> Basic styles for common interface components like tabs and pills, navbar, page headers, and more.</li> + <li><strong><a href="http://twitter.github.com/bootstrap/javascript.html">Javascript plugins:</a></strong> Similar to the Components section, these Javascript plugins are interactive components for things like tooltips, popovers, modals, and more.</li> + </ul> + <p>Together, the <strong>Components</strong> and <strong>Javascript plugins</strong> sections provide the following interface elements:</p> + <ul> + <li>Button groups</li> + <li>Button dropdowns</li> + <li>Navigational tabs, pills, and lists</li> + <li>Navbar</li> + <li>Labels</li> + <li>Badges</li> + <li>Page headers and hero unit</li> + <li>Thumbnails</li> + <li>Alerts</li> + <li>Progress bars</li> + <li>Modals</li> + <li>Dropdowns</li> + <li>Tooltips</li> + <li>Popovers</li> + <li>Accordion</li> + <li>Carousel</li> + <li>Typeahead</li> + </ul> + <p>In future guides, we may walk through these components individually in more detail. Until then, look for each of these in the documentation for information on how to utilize and customize them.</p> + </section> + + + + <section id="html-template"> + <div class="page-header"> + <h1>Basic HTML template</h1> + </div> + <p>Now that we’ve got the basic information on Bootstrap out of the way, we can focus on getting started. To do that, we’ll utilize a basic HTML template that includes everything we’ve mentioned in the <a href="#file-structure">File structure</a>.</p> + <p>As previously mentioned, we won’t cover the basics of writing HTML and CSS here. Instead, we’ll leapfrog through various points in web development complexity to give you the broadest and most complete overview.</p> + <p>Now, here’s a look at a <strong>typical HTML file</strong>:</p> + <pre class="prettyprint linenums"> + <html> + <head> + <title>Bootstrap 101 Template</title> + </head> + <body> + <h1>Hello, world!</h1> + </body> + </html> + </pre> + <p>To make this <strong>a Bootstrapped template</strong>, just include the appropriate CSS and JS files:</p> + <pre class="prettyprint linenums"> + <html> + <head> + <title>Bootstrap 101 Template</title> + <!-- Bootstrap --> + <link href="css/bootstrap.min.css" rel="stylesheet"> + <script src="js/bootstrap.min.js"></script> + </head> + <body> + <h1>Hello, world!</h1> + </body> + </html> + </pre> + <p>And you’re set. With those two files added, you can begin to write Bootstrap-friendly HTML, CSS, and JS to build any site or application you like. Head to the Bootstrap docs for information, examples, and even code snippets for the Bootstrap grid system, base HTML styles, components, and even responsive features.</p> + </section> + + + + </div> +</div> + + <!-- Footer + ================================================== --> + <footer class="footer"> + <p class="pull-right"><a href="#">Back to top</a></p> + <p>Designed and built with all the love in the world <a href="http://twitter.com/twitter" target="_blank">@twitter</a> by <a href="http://twitter.com/mdo" target="_blank">@mdo</a> and <a href="http://twitter.com/fat" target="_blank">@fat</a>.</p> + <p>Code licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>. Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p> + <p>Icons from <a href="http://glyphicons.com">Glyphicons Free</a>, licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p> + <ul class="footer-links"> + <li><a href="http://blog.getbootstrap.com">Read the blog</a></li> + <li><a href="https://github.com/twitter/bootstrap/issues?state=open">Submit issues</a></li> + <li><a href="https://github.com/twitter/bootstrap/wiki">Roadmap and changelog</a></li> + </ul> + </footer> + + </div> + + + + <!-- Le javascript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script> + <script src="assets/js/jquery.js"></script> + <script src="assets/js/google-code-prettify/prettify.js"></script> + <script src="assets/js/bootstrap-transition.js"></script> + <script src="assets/js/bootstrap-alert.js"></script> + <script src="assets/js/bootstrap-modal.js"></script> + <script src="assets/js/bootstrap-dropdown.js"></script> + <script src="assets/js/bootstrap-scrollspy.js"></script> + <script src="assets/js/bootstrap-tab.js"></script> + <script src="assets/js/bootstrap-tooltip.js"></script> + <script src="assets/js/bootstrap-popover.js"></script> + <script src="assets/js/bootstrap-button.js"></script> + <script src="assets/js/bootstrap-collapse.js"></script> + <script src="assets/js/bootstrap-carousel.js"></script> + <script src="assets/js/bootstrap-typeahead.js"></script> + <script src="assets/js/application.js"></script> + + + </body> +</html> diff --git a/docs/index.html b/docs/index.html index 1a9763bb20..ae841b3c16 100644 --- a/docs/index.html +++ b/docs/index.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> @@ -123,7 +123,7 @@ <div class="span4"> <img src="assets/img/bs-docs-bootstrap-features.png"> <h2>Packed with features.</h2> - <p>Utilize the 12-column responsive <a href="./scaffolding.html#grid">grid</a>, dozens of components, <a href="./javascript.html">javascript plugins</a>, typography, form controls, and even a <a href="./download.html">web-based Customizer</a> to make Bootstrap your own.</p> + <p>A 12-column responsive <a href="./scaffolding.html#grid">grid</a>, dozens of components, <a href="./javascript.html">javascript plugins</a>, typography, form controls, and even a <a href="./download.html">web-based Customizer</a> to make Bootstrap your own.</p> </div> </div> diff --git a/docs/javascript.html b/docs/javascript.html index b321e6632c..888391ba53 100644 --- a/docs/javascript.html +++ b/docs/javascript.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> @@ -95,6 +95,27 @@ </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#transitions">Transitions</a></li> + <li><a href="#modals">Modal</a></li> + <li><a href="#dropdowns">Dropdown</a></li> + <li><a href="#scrollspy">Scrollspy</a></li> + <li><a href="#tabs">Tab</a></li> + <li><a href="#tooltips">Tooltip</a></li> + <li><a href="#popovers">Popover</a></li> + <li><a href="#alerts">Alert</a></li> + <li><a href="#buttons">Button</a></li> + <li><a href="#collapse">Collapse</a></li> + <li><a href="#carousel">Carousel</a></li> + <li><a href="#typeahead">Typeahead</a></li> + <li><a href="#affix">Affix</a></li> + </ul> + </div> + <div class="span9"> + + <!-- Overview @@ -1570,6 +1591,8 @@ $('.carousel').carousel({ </pre> </section> +</div> +</div> <!-- Footer ================================================== --> diff --git a/docs/scaffolding.html b/docs/scaffolding.html index 8df8a818f7..09ea5664b2 100644 --- a/docs/scaffolding.html +++ b/docs/scaffolding.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> @@ -88,6 +88,20 @@ </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#global">Global styles</a></li> + <li><a href="#gridSystem">Grid system</a></li> + <li><a href="#fluidGridSystem">Fluid grid system</a></li> + <li><a href="#gridCustomization">Customizing</a></li> + <li><a href="#layouts">Layouts</a></li> + <li><a href="#responsive">Responsive design</a></li> + </ul> + </div> + <div class="span9"> + + <!-- Global Bootstrap settings ================================================== --> @@ -585,6 +599,8 @@ </section> +</div> +</div> <!-- Footer ================================================== --> diff --git a/docs/templates/layout.mustache b/docs/templates/layout.mustache index 7f223ae68c..dbec68eebd 100644 --- a/docs/templates/layout.mustache +++ b/docs/templates/layout.mustache @@ -39,7 +39,7 @@ {{/production}} </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> diff --git a/docs/templates/pages/base-css.mustache b/docs/templates/pages/base-css.mustache index 5435689bde..8985e7c69f 100644 --- a/docs/templates/pages/base-css.mustache +++ b/docs/templates/pages/base-css.mustache @@ -18,6 +18,20 @@ </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#typography">{{_i}}Typography{{/i}}</a></li> + <li><a href="#code">{{_i}}Code{{/i}}</a></li> + <li><a href="#tables">{{_i}}Tables{{/i}}</a></li> + <li><a href="#forms">{{_i}}Forms{{/i}}</a></li> + <li><a href="#buttons">{{_i}}Buttons{{/i}}</a></li> + <li><a href="#icons">{{_i}}Icons by Glyphicons{{/i}}</a></li> + </ul> + </div> + <div class="span9"> + + <!-- Typography ================================================== --> @@ -1562,3 +1576,6 @@ </form> </section> + +</div> +</div>
\ No newline at end of file diff --git a/docs/templates/pages/components.mustache b/docs/templates/pages/components.mustache index 5fb11ccf28..306c4dea21 100644 --- a/docs/templates/pages/components.mustache +++ b/docs/templates/pages/components.mustache @@ -35,13 +35,34 @@ </div> </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#dropdowns">{{_i}}Dropdowns{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#buttonGroups">{{_i}}Button groups{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#buttonDropdowns">{{_i}}Button dropdowns{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#navs">{{_i}}Navs{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#navbar">{{_i}}Navbar{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#breadcrumbs">{{_i}}Breadcrumbs{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#pagination">{{_i}}Pagination{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#labels">{{_i}}Labels{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#badges">{{_i}}Badges{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#typography">{{_i}}Typography{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#thumbnails">{{_i}}Thumbnails{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#alerts">{{_i}}Alerts{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#progress">{{_i}}Progress bars{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#misc">{{_i}}Misc{{/i}} <i class="icon-chevron-right"></i></a></li> + </ul> + </div> + <div class="span9"> + <!-- Dropdowns ================================================== --> <section id="dropdowns"> <div class="page-header"> - <h1>{{_i}}Dropdown menus{{/i}} <small>{{_i}}Dropdown and dropup menus for contextual actions{{/i}}</small></h1> + <h1>{{_i}}Dropdown menus{{/i}}</h1> </div> <h2>{{_i}}Example{{/i}}</h2> @@ -225,7 +246,7 @@ ================================================== --> <section id="buttonDropdowns"> <div class="page-header"> - <h1>{{_i}}Button dropdown menus{{/i}} <small>{{_i}}Built on button groups to provide contextual menus{{/i}}</small></h1> + <h1>{{_i}}Button dropdown menus{{/i}}</h1> </div> @@ -560,7 +581,7 @@ ================================================== --> <section id="navs"> <div class="page-header"> - <h1>{{_i}}Nav, tabs, and pills{{/i}} <small>{{_i}}Highly customizable list-style navigation{{/i}}</small></h1> + <h1>{{_i}}Nav: tabs, pills, and lists{{/i}}</small></h1> </div> <h2>{{_i}}Lightweight defaults{{/i}} <small>{{_i}}Same markup, different classes{{/i}}</small></h2> @@ -2142,3 +2163,6 @@ class="clearfix" </pre> </section> + + </div> +</div> diff --git a/docs/templates/pages/getting-started.mustache b/docs/templates/pages/getting-started.mustache new file mode 100644 index 0000000000..5e1407436c --- /dev/null +++ b/docs/templates/pages/getting-started.mustache @@ -0,0 +1,143 @@ +<!-- Masthead +================================================== --> +<header class="jumbotron subhead" id="overview"> + <h1>{{_i}}Getting started{{/i}}</h1> + <p class="lead">{{_i}}Overview of the project, it's contents, and how to get started with a simple template.{{/i}}</p> +</header> + +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#prerequisites">{{_i}}Prerequisites{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#file-structure">{{_i}}File structure{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#contents">{{_i}}What's included{{/i}} <i class="icon-chevron-right"></i></a></li> + <li><a href="#html-template">{{_i}}HTML template{{/i}} <i class="icon-chevron-right"></i></a></li> + </ul> + </div> + <div class="span9"> + + + <section id="prerequisites"> + <div class="page-header"> + <h1>{{_i}}Prerequisites{{/i}}</h1> + </div> + <p>{{_i}}Before getting started, you need the following:{{/i}}</p> + <ul> + <li>{{_i}}An unzipped copy of the <a href="https://github.com/twitter/bootstrap/zipball/master">latest version of Bootstrap</a> (which includes all CSS, JavaScript, and images).{{/i}}</li> + <li>{{_i}}An editor of your choice for writing code (I recommend <a href="http://sublimetext.com/2">Sublime Text 2</a>).{{/i}}</li> + <li>{{_i}}Some working knowledge of HTML and CSS.{{/i}}</li> + </ul> + <p>{{_i}}When ready, proceed to the next section, <a href="#file-structure">File structure</a>.{{/i}}</p> + </section> + + + + <section id="file-structure"> + <div class="page-header"> + <h1>{{_i}}File structure{{/i}}</h1> + </div> + <p>{{_i}}Once unzipped, the structure of Bootstrap’s files looks like this:{{/i}}</p> + <ul> + <li>bootstrap/ + <ul> + <li>css/ + <ul> + <li>bootstrap.css</li> + <li>bootstrap.min.css</li> + </ul> + </li> + <li>js/ + <ul> + <li>bootstrap.js</li> + <li>bootstrap.min.js</li> + </ul> + </li> + <li>img/ + <ul> + <li>glyphicons-halflings.png</li> + <li>glyphicons-halflings-white.png</li> + </ul> + </li> + <li>README.md</li> + </ul> + </li> + </ul> + <p>{{_i}}This is the most basic form of Bootstrap: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (<code>bootstrap.*</code>), as well as compiled and minified CSS and JS (<code>bootstrap.min.*</code>). The image files are compressed using <a href="http://imageoptim.com/">ImageOptim</a>, a Mac app for compressing PNGs.{{/i}}</p> + </section> + + + + <section id="contents"> + <div class="page-header"> + <h1>{{_i}}What's included{{/i}}</h1> + </div> + <p>{{_i}}Bootstrap comes equipped with CSS for all sorts of things, but they can be summarized with a handful of categories visible at the top of the <a href="http://getbootstrap.com">Bootstrap documentation</a>:{{/i}}</p> + <ul> + <li><strong><a href="http://twitter.github.com/bootstrap/scaffolding.html">Scaffolding:</a></strong> Global styles for the body to reset type and background, link styles, grid system, and two simple layouts.</li> + <li><strong><a href="http://twitter.github.com/bootstrap/base-css.html">Base CSS:</a></strong> Styles for common HTML elements like typography, code, tables, forms, and buttons. Also includes <a href="http://glyphicons.com">Glyphicons</a>, a great little icon set.</li> + <li><strong><a href="http://twitter.github.com/bootstrap/components.html">Components:</a></strong> Basic styles for common interface components like tabs and pills, navbar, page headers, and more.</li> + <li><strong><a href="http://twitter.github.com/bootstrap/javascript.html">Javascript plugins:</a></strong> Similar to the Components section, these Javascript plugins are interactive components for things like tooltips, popovers, modals, and more.</li> + </ul> + <p>Together, the <strong>Components</strong> and <strong>Javascript plugins</strong> sections provide the following interface elements:</p> + <ul> + <li>Button groups</li> + <li>Button dropdowns</li> + <li>Navigational tabs, pills, and lists</li> + <li>Navbar</li> + <li>Labels</li> + <li>Badges</li> + <li>Page headers and hero unit</li> + <li>Thumbnails</li> + <li>Alerts</li> + <li>Progress bars</li> + <li>Modals</li> + <li>Dropdowns</li> + <li>Tooltips</li> + <li>Popovers</li> + <li>Accordion</li> + <li>Carousel</li> + <li>Typeahead</li> + </ul> + <p>{{_i}}In future guides, we may walk through these components individually in more detail. Until then, look for each of these in the documentation for information on how to utilize and customize them.{{/i}}</p> + </section> + + + + <section id="html-template"> + <div class="page-header"> + <h1>{{_i}}Basic HTML template{{/i}}</h1> + </div> + <p>{{_i}}Now that we’ve got the basic information on Bootstrap out of the way, we can focus on getting started. To do that, we’ll utilize a basic HTML template that includes everything we’ve mentioned in the <a href="#file-structure">File structure</a>.{{/i}}</p> + <p>{{_i}}As previously mentioned, we won’t cover the basics of writing HTML and CSS here. Instead, we’ll leapfrog through various points in web development complexity to give you the broadest and most complete overview.{{/i}}</p> + <p>{{_i}}Now, here’s a look at a <strong>typical HTML file</strong>:{{/i}}</p> + <pre class="prettyprint linenums"> + <html> + <head> + <title>Bootstrap 101 Template</title> + </head> + <body> + <h1>Hello, world!</h1> + </body> + </html> + </pre> + <p>{{_i}}To make this <strong>a Bootstrapped template</strong>, just include the appropriate CSS and JS files:{{/i}}</p> + <pre class="prettyprint linenums"> + <html> + <head> + <title>Bootstrap 101 Template</title> + <!-- Bootstrap --> + <link href="css/bootstrap.min.css" rel="stylesheet"> + <script src="js/bootstrap.min.js"></script> + </head> + <body> + <h1>Hello, world!</h1> + </body> + </html> + </pre> + <p>{{_i}}And you’re set. With those two files added, you can begin to write Bootstrap-friendly HTML, CSS, and JS to build any site or application you like. Head to the Bootstrap docs for information, examples, and even code snippets for the Bootstrap grid system, base HTML styles, components, and even responsive features.{{/i}}</p> + </section> + + + + </div> +</div>
\ No newline at end of file diff --git a/docs/templates/pages/index.mustache b/docs/templates/pages/index.mustache index 2990ed4f1b..e90df3d084 100644 --- a/docs/templates/pages/index.mustache +++ b/docs/templates/pages/index.mustache @@ -53,7 +53,7 @@ <div class="span4"> <img src="assets/img/bs-docs-bootstrap-features.png"> <h2>{{_i}}Packed with features.{{/i}}</h2> - <p>{{_i}}Utilize the 12-column responsive <a href="./scaffolding.html#grid">grid</a>, dozens of components, <a href="./javascript.html">javascript plugins</a>, typography, form controls, and even a <a href="./download.html">web-based Customizer</a> to make Bootstrap your own.{{/i}}</p> + <p>{{_i}}A 12-column responsive <a href="./scaffolding.html#grid">grid</a>, dozens of components, <a href="./javascript.html">javascript plugins</a>, typography, form controls, and even a <a href="./download.html">web-based Customizer</a> to make Bootstrap your own.{{/i}}</p> </div> </div> diff --git a/docs/templates/pages/javascript.mustache b/docs/templates/pages/javascript.mustache index 6f51417fa0..13d5285b70 100644 --- a/docs/templates/pages/javascript.mustache +++ b/docs/templates/pages/javascript.mustache @@ -25,6 +25,27 @@ </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#transitions">{{_i}}Transitions{{/i}}</a></li> + <li><a href="#modals">{{_i}}Modal{{/i}}</a></li> + <li><a href="#dropdowns">{{_i}}Dropdown{{/i}}</a></li> + <li><a href="#scrollspy">{{_i}}Scrollspy{{/i}}</a></li> + <li><a href="#tabs">{{_i}}Tab{{/i}}</a></li> + <li><a href="#tooltips">{{_i}}Tooltip{{/i}}</a></li> + <li><a href="#popovers">{{_i}}Popover{{/i}}</a></li> + <li><a href="#alerts">{{_i}}Alert{{/i}}</a></li> + <li><a href="#buttons">{{_i}}Button{{/i}}</a></li> + <li><a href="#collapse">{{_i}}Collapse{{/i}}</a></li> + <li><a href="#carousel">{{_i}}Carousel{{/i}}</a></li> + <li><a href="#typeahead">{{_i}}Typeahead{{/i}}</a></li> + <li><a href="#affix">{{_i}}Affix{{/i}}</a></li> + </ul> + </div> + <div class="span9"> + + <!-- Overview @@ -1501,3 +1522,6 @@ $('.carousel').carousel({ ... </pre> </section> + +</div> +</div>
\ No newline at end of file diff --git a/docs/templates/pages/scaffolding.mustache b/docs/templates/pages/scaffolding.mustache index 3eda645ca8..2d25814001 100644 --- a/docs/templates/pages/scaffolding.mustache +++ b/docs/templates/pages/scaffolding.mustache @@ -18,6 +18,20 @@ </header> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#global">{{_i}}Global styles{{/i}}</a></li> + <li><a href="#gridSystem">{{_i}}Grid system{{/i}}</a></li> + <li><a href="#fluidGridSystem">{{_i}}Fluid grid system{{/i}}</a></li> + <li><a href="#gridCustomization">{{_i}}Customizing{{/i}}</a></li> + <li><a href="#layouts">{{_i}}Layouts{{/i}}</a></li> + <li><a href="#responsive">{{_i}}Responsive design{{/i}}</a></li> + </ul> + </div> + <div class="span9"> + + <!-- Global Bootstrap settings ================================================== --> @@ -518,3 +532,6 @@ </ul> </section> + +</div> +</div>
\ No newline at end of file diff --git a/docs/upgrading.html b/docs/upgrading.html index 6d605b7368..e322337628 100644 --- a/docs/upgrading.html +++ b/docs/upgrading.html @@ -27,7 +27,7 @@ </head> - <body data-spy="scroll" data-target=".subnav" data-offset="50"> + <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10"> <!-- Navbar ================================================== --> |