aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJacob Thornton <[email protected]>2011-09-10 22:17:37 -0700
committerJacob Thornton <[email protected]>2011-09-10 22:17:37 -0700
commitc40e0de3c1d837b2754f7717ebdc4a29c5f92cd8 (patch)
tree9f501ded45d3326bf58640c325b7e6cbfd0f2b54 /docs
parent64176caa972fdf925fe244cdbf1d53d82da592f4 (diff)
parent536fe2c7437969ec64c14d6d790c5e7c684a6ccc (diff)
downloadbootstrap-c40e0de3c1d837b2754f7717ebdc4a29c5f92cd8.tar.xz
bootstrap-c40e0de3c1d837b2754f7717ebdc4a29c5f92cd8.zip
Merge branch '1.3-wip' of github.com:twitter/bootstrap into 1.3-wip
Conflicts: docs/index.html
Diffstat (limited to 'docs')
-rw-r--r--docs/assets/css/docs.css167
-rw-r--r--docs/index.html129
-rw-r--r--docs/javascript.html45
3 files changed, 210 insertions, 131 deletions
diff --git a/docs/assets/css/docs.css b/docs/assets/css/docs.css
index 187fc7984..29fdcf3f0 100644
--- a/docs/assets/css/docs.css
+++ b/docs/assets/css/docs.css
@@ -4,6 +4,7 @@
Bootstrap's documentation styles
Special styles for presenting Bootstrap's documentation and examples
*/
+
/* Body and structure
-------------------------------------------------- */
body {
@@ -16,56 +17,101 @@ section {
section > .row {
margin-bottom: 10px;
}
-#masthead, #footer {
- background-color: #049cd9;
- background-repeat: no-repeat;
- background-image: -webkit-gradient(linear, left top, left bottom, from(#004D9F), to(#049cd9));
- background-image: -webkit-linear-gradient(#004D9F, #049cd9);
- background-image: -moz-linear-gradient(#004D9F, #049cd9);
- background-image: -o-linear-gradient(top, #004D9F, #049cd9);
- background-image: -khtml-gradient(linear, left top, left bottom, from(#004D9F), to(#049cd9));
- filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#004D9F', endColorstr='#049cd9', GradientType=0); /* IE8 and down */
+
+
+/* Jumbotrons
+-------------------------------------------------- */
+.jumbotron {
+ padding-top: 40px;
}
-#masthead div.inner, #footer div.inner {
+.jumbotron .inner {
background: transparent url(../img/grid-18px.png) top center;
padding: 45px 0;
- -webkit-box-shadow: inset 0 10px 30px rgba(0, 0, 0, 0.3);
- -moz-box-shadow: inset 0 10px 30px rgba(0, 0, 0, 0.3);
- box-shadow: inset 0 10px 30px rgba(0, 0, 0, 0.3);
-}
-#masthead h1,
-#footer h1,
-#masthead p,
-#footer p {
- color: #fff;
- text-shadow: 0 1px 1px rgba(0,0,0,.3);
+ -webkit-box-shadow: inset 0 10px 30px rgba(0,0,0,.3);
+ -moz-box-shadow: inset 0 10px 30px rgba(0,0,0,.3);
+ box-shadow: inset 0 10px 30px rgba(0,0,0,.3);
}
-#masthead p a,
-#footer p a {
+.jumbotron h1,
+.jumbotron p {
+ margin-bottom: 9px;
color: #fff;
- font-weight: bold;
-}
-#masthead {
- padding-top: 40px;
-}
-#masthead h1,
-#masthead p {
text-align: center;
- margin-bottom: 9px;
+ text-shadow: 0 1px 1px rgba(0,0,0,.3);
}
-#masthead h1 {
+.jumbotron h1 {
font-size: 54px;
line-height: 1;
text-shadow: 0 1px 2px rgba(0,0,0,.5);
}
-#masthead p {
+.jumbotron p {
font-weight: 300;
}
-#masthead p.lead {
+.jumbotron .lead {
font-size: 20px;
line-height: 27px;
}
+.jumbotron p a {
+ color: #fff;
+ font-weight: bold;
+}
+/* Specific jumbotrons
+------------------------- */
+/* main docs page */
+.masthead {
+ background-color: #049cd9;
+ background-repeat: no-repeat;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#004D9F), to(#049cd9));
+ background-image: -webkit-linear-gradient(#004D9F, #049cd9);
+ background-image: -moz-linear-gradient(#004D9F, #049cd9);
+ background-image: -o-linear-gradient(top, #004D9F, #049cd9);
+ background-image: -khtml-gradient(linear, left top, left bottom, from(#004D9F), to(#049cd9));
+ filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#004D9F', endColorstr='#049cd9', GradientType=0); /* IE8 and down */
+}
+/* supporting docs pages */
+.subhead {
+ background-color: #767d80;
+ background-repeat: no-repeat;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#565d60), to(#767d80));
+ background-image: -webkit-linear-gradient(#565d60, #767d80);
+ background-image: -moz-linear-gradient(#565d60, #767d80);
+ background-image: -o-linear-gradient(top, #565d60, #767d80);
+ background-image: -khtml-gradient(linear, left top, left bottom, from(#565d60), to(#767d80));
+ filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#565d60', endColorstr='#767d80', GradientType=0); /* IE8 and down */
+}
+.subhead .inner {
+ padding: 36px 0 27px;
+}
+.subhead h1,
+.subhead p {
+ text-align: left;
+}
+.subhead h1 {
+ font-size: 40px;
+}
+.subhead p a {
+ font-weight: normal;
+}
+
+
+/* Footer
+-------------------------------------------------- */
+.footer {
+ background-color: #eee;
+ padding: 30px 0;
+ text-shadow: 0 1px 0 #fff;
+ border-top: 1px solid #e5e5e5;
+ -webkit-box-shadow: inset 0 5px 15px rgba(0,0,0,.025);
+ -moz-box-shadow: inset 0 5px 15px rgba(0,0,0,.025);
+ box-shadow: inset 0 5px 15px rgba(0,0,0,.025);
+}
+.footer p {
+ color: #555;
+}
+
+
+/* Quickstart section for getting le code
+-------------------------------------------------- */
.quickstart {
background-color: #f5f5f5;
background-repeat: repeat-x;
@@ -127,16 +173,7 @@ section > .row {
white-space: nowrap;
overflow: hidden;
}
-#footer {
- margin-top: 80px;
-}
-#footer p {
- margin-bottom: 0;
- color: rgba(255,255,255,.8)
-}
-#footer p.right {
- float: right;
-}
+
/* Special grid styles
-------------------------------------------------- */
@@ -162,6 +199,8 @@ section > .row {
margin-top: 0;
margin-bottom: 0;
}
+
+
/* Render mini layout previews
-------------------------------------------------- */
.diagram,
@@ -208,18 +247,20 @@ section > .row {
width: 300px;
margin-left: 10px;
}
+
+
/* Topbar special styles
-------------------------------------------------- */
-div.topbar-wrapper {
+.topbar-wrapper {
position: relative;
height: 40px;
margin: 5px 0 15px;
}
-div.topbar-wrapper div.topbar {
+.topbar-wrapper .topbar {
position: absolute;
margin: 0 -20px;
}
-div.topbar-wrapper div.topbar .topbar-inner {
+.topbar-wrapper .topbar .topbar-inner {
padding-left: 20px;
padding-right: 20px;
-webkit-border-radius: 4px;
@@ -227,61 +268,53 @@ div.topbar-wrapper div.topbar .topbar-inner {
border-radius: 4px;
}
-/* Topbar special styles for js
--------------------------------------------------- */
-#bootstrap-js div.topbar-wrapper {
- position: relative;
- height: 40px;
- margin: 5px 0 15px;
+/* Topbar in js docs
+------------------------- */
+#bootstrap-js .topbar-wrapper {
z-index: 1;
}
-
-#bootstrap-js div.topbar-wrapper div.topbar {
+#bootstrap-js .topbar-wrapper .topbar {
position: absolute;
margin: 0 -20px;
}
-
-#bootstrap-js div.topbar-wrapper div.topbar .fill {
+#bootstrap-js .topbar-wrapper .topbar .topbar-inner {
padding-left: 20px;
padding-right: 20px;
-webkit-border-radius: 4px;
-moz-border-radius: 4px;
border-radius: 4px;
}
-
-#bootstrap-js div.topbar-wrapper .container {
+#bootstrap-js .topbar-wrapper .container {
width: auto;
}
+
/* Popover docs
-------------------------------------------------- */
-div.popover-well {
+.popover-well {
min-height: 160px;
}
-
-div.popover-well div.popover {
+.popover-well .popover {
display: block;
}
-
-div.popover-well div.popover-wrapper {
+.popover-well .popover-wrapper {
width: 50%;
height: 160px;
float: left;
margin-left: 55px;
position: relative;
}
-
-div.popover-well div.popover-menu-wrapper {
+.popover-well .popover-menu-wrapper {
height: 80px;
}
-
img.large-bird {
margin: 5px 0 0 310px;
opacity: .1;
}
+
/* Pretty Print
-------------------------------------------------- */
-PRE.prettyprint {
+pre.prettyprint {
overflow: hidden;
} \ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index f914b31b2..6f8ad30a2 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -61,7 +61,7 @@
<!-- Masthead (blueprinty thing)
================================================== -->
- <div id="masthead">
+ <header class="jumbotron masthead">
<div class="inner">
<div class="container">
<h1>Bootstrap, from Twitter</h1>
@@ -72,7 +72,7 @@
<p><strong>Nerd alert:</strong> Bootstrap is <a href="#less" title="Read about using Bootstrap with Less">built with Less</a> and was designed to work out of the gate with modern browsers in mind.</p>
</div><!-- /container -->
</div>
- </div>
+ </header>
<!-- Quickstart options
================================================== -->
@@ -1516,13 +1516,14 @@ Lorem ipsum dolar sit amet illo error <a href="#" title="below">ipsum</a> verita
</div>
<div class="row">
<div class="span4">
+ <h2>Getting started</h2>
<p>Integrating javascript with the Bootstrap library is super easy. Below we go over the basics and provide you with some awesome plugins to get you started!</p>
+ <hr>
+ <p><a class="btn primary" href="./javascript.html">Skip to Bootstrap plugins &raquo;</a></p>
</div>
<div class="span12">
- <h2>Getting started</h2>
- <p>We've set out to make your interactive work with Bootstrap even more simple, offering several lightweight plugins for things like modals, tooltips, and other dynamic components. These plugins have been coded up to work with either <a href="http://jquery.com/" target="_blank">jQuery</a> or <a href="http://ender.no.de" target="_blank">Ender</a>, but we encourage you to extend and modify them to fit your development needs!</p>
- <h2>Do I need javascript?</h2>
- <p>The short answer is <strong>no</strong>... of course not! However, for those who need it, we've provided the plugins below to help you understand how to integrate bootstrap with javascript and to give you a quick lightweight option for dropping something in and getting the basic functionality right away! For more information on these plugins and to see demos of them in action, please refer to our <a href="./javascript.html">plugin documentation page</a>.</p>
+ <h3>What's included</h3>
+ <p>Bring some of Bootstrap's primary components to life with new custom plugins that work with <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://ender.no.de" target="_blank">Ender</a>. We encourage you to extend and modify them to fit your specific development needs.</p>
<table class="zebra-striped">
<thead>
<tr>
@@ -1544,6 +1545,10 @@ Lorem ipsum dolar sit amet illo error <a href="#" title="below">ipsum</a> verita
<td>This plugin is for adding dropdown interaction to the bootstrap topbar or tabbed navigations.</td>
</tr>
<tr>
+ <td><a href="./javascript.html#scrollspy">bootstrap-scrollspy.js</a></td>
+ <td>The ScrollSpy plugin is for adding an auto updating nav based on scroll position to the bootstrap topbar.</td>
+ </tr>
+ <tr>
<td><a href="./javascript.html#tabs">bootstrap-tabs.js</a></td>
<td>This plugin adds quick, dynamic tab and pill functionality for cycling through local content.</td>
</tr>
@@ -1557,6 +1562,10 @@ Lorem ipsum dolar sit amet illo error <a href="#" title="below">ipsum</a> verita
</tr>
</tbody>
</table>
+ <h3>Is javascript necessary?</h3>
+ <p><strong>Nope!</strong> Bootstrap is designed first and foremost to be a CSS library. This javascript provides a basic interactive layer on top of the included styles.</p>
+ <p>However, for those who do need javascript, we've provided the plugins above to help you understand how to integrate Bootstrap with javascript and to give you a quick, lightweight option for the basic functionality right away.</p>
+ <p>For more information and to see some live demos, please refer to our <a href="./javascript.html">plugin documentation page</a>.</p>
</div>
</div>
@@ -1634,34 +1643,13 @@ Lorem ipsum dolar sit amet illo error <a href="#" title="below">ipsum</a> verita
font-weight: @weight;
line-height: @lineHeight;
}
- .serif(@weight: normal, @size: 14px, @lineHeight: 20px) {
- font-family: "Georgia", Times New Roman, Times, sans-serif;
- font-size: @size;
- font-weight: @weight;
- line-height: @lineHeight;
- }
- .monospace(@weight: normal, @size: 12px, @lineHeight: 20px) {
- font-family: "Monaco", Courier New, monospace;
- font-size: @size;
- font-weight: @weight;
- line-height: @lineHeight;
- }
+ ...
}
</pre>
<h4>Gradients</h4>
<pre class="prettyprint linenums">
#gradient {
- .horizontal (@startColor: #555, @endColor: #333) {
- background-color: @endColor;
- background-repeat: repeat-x;
- background-image: -khtml-gradient(linear, left top, right top, from(@startColor), to(@endColor)); // Konqueror
- background-image: -moz-linear-gradient(left, @startColor, @endColor); // FF 3.6+
- background-image: -ms-linear-gradient(left, @startColor, @endColor); // IE10
- background-image: -webkit-gradient(linear, left top, right top, color-stop(0%, @startColor), color-stop(100%, @endColor)); // Safari 4+, Chrome 2+
- background-image: -webkit-linear-gradient(left, @startColor, @endColor); // Safari 5.1+, Chrome 10+
- background-image: -o-linear-gradient(left, @startColor, @endColor); // Opera 11.10
- background-image: linear-gradient(left, @startColor, @endColor); // Le standard
- }
+ ...
.vertical (@startColor: #555, @endColor: #333) {
background-color: @endColor;
background-repeat: repeat-x;
@@ -1673,16 +1661,11 @@ Lorem ipsum dolar sit amet illo error <a href="#" title="below">ipsum</a> verita
background-image: -o-linear-gradient(@startColor, @endColor); // Opera 11.10
background-image: linear-gradient(@startColor, @endColor); // The standard
}
- .directional (@startColor: #555, @endColor: #333, @deg: 45deg) {
- ...
- }
- .vertical-three-colors(@startColor: #00b3ee, @midColor: #7a43b6, @colorStop: 50%, @endColor: #c3325f) {
- ...
- }
+ ...
}
</pre>
-<h3>Operations and grid system</h3>
+<h3>Operations</h3>
<p>Get fancy and perform some math to generate flexible and powerful mixins like the one below.</p>
<pre class="prettyprint linenums">
// Griditude
@@ -1691,37 +1674,73 @@ Lorem ipsum dolar sit amet illo error <a href="#" title="below">ipsum</a> verita
@gridGutterWidth: 20px;
@siteWidth: (@gridColumns * @gridColumnWidth) + (@gridGutterWidth * (@gridColumns - 1));
-// Grid System
-.container {
- width: @siteWidth;
- margin: 0 auto;
- .clearfix();
-}
+// Make some columns
.columns(@columnSpan: 1) {
width: (@gridColumnWidth * @columnSpan) + (@gridGutterWidth * (@columnSpan - 1));
}
-.offset(@columnOffset: 1) {
- margin-left: (@gridColumnWidth * @columnOffset) + (@gridGutterWidth * (@columnOffset - 1)) + @extraSpace;
-}
</pre>
+
+ <h2>Compiling Less</h2>
+ <p>After modifying the <code>.less</code> files in /lib/, you'll need to recompile them in order to regenerate the bootstrap-*.*.*.css and bootstrap-*.*.*.min.css files. If you're submitting a pull request to GitHub, you must always recompile.</p>
+ <h3>Ways to compile</h3>
+ <table>
+ <thead>
+ <tr>
+ <th style="width: 120px;">Method</th>
+ <th>Steps</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <tr>
+ <td>Node with makefile</td>
+ <td>
+
+ </td>
+ </tr>
+ <td>Javascript</td>
+ <td>
+ <p><a href="http://lesscss.org/">Download the latest Less.js</a> and include the path to it (and your Bootstrap code) in the <code>head</code>.</p>
+<pre class="prettyprint">
+&lt;link rel="stylesheet/less" href="/path/to/bootstrap.less"&gt;
+&lt;script src="/path/to/less.js"&gt;&lt;/script&gt;
+</pre>
+ <p>To recompile the .less files, just save them and reload your page. Less.js compiles them and stores them in local storage.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>Command line</td>
+ <td>
+
+ </td>
+ </tr>
+ <tr>
+ <td>Less Mac app</td>
+ <td>
+ <p><a href="http://incident57.com/less/">The unofficial Mac app</a> watches directories of .less files and compiles the code to local files after every save of a watched .less file.</p>
+ <p>If you like, you can toggle preferences in the app for automatic minifying and which directory the compiled files end up in.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
</div>
</div>
</section>
+
+
</div><!-- /container -->
- <div id="footer">
- <div class="inner">
- <div class="container">
- <p class="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>.<br />
- Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>.
- </p>
- </div>
+ <footer class="footer">
+ <div class="container">
+ <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>.<br />
+ Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>.
+ </p>
</div>
- </div>
+ </footer>
</body>
</html>
diff --git a/docs/javascript.html b/docs/javascript.html
index 294f5dbe4..b830e7d64 100644
--- a/docs/javascript.html
+++ b/docs/javascript.html
@@ -44,6 +44,7 @@
<div class="container">
<h3><a href="#">Bootstrap JS</a></h3>
<ul>
+ <li><a href="#overview">Overview</a></li>
<li><a href="#modal">Modals</a></li>
<li><a href="#dropdown">Dropdown</a></li>
<li><a href="#scrollspy">ScrollSpy</a></li>
@@ -56,6 +57,20 @@
</div>
</div>
+ <!-- Masthead (blueprinty thing)
+ ================================================== -->
+ <header class="jumbotron subhead" id="overview">
+ <div class="inner">
+ <div class="container">
+ <h1>Javascript for Bootstrap</h1>
+ <p class="lead">
+ Bring Bootstrap's components to life with new, custom plugins that work with <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://ender.no.de" target="_blank">Ender</a>.
+ </p>
+ <p><a href="./index.html">&larr; Back to Bootstrap home</a></p>
+ </div><!-- /container -->
+ </div>
+ </header>
+
<div class="container">
<!-- Modal
@@ -71,7 +86,7 @@
<a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a>
</div>
<div class="span12 columns">
- <h2>Using bootstrap-modal</h2>
+ <h3>Using bootstrap-modal</h3>
<pre class="prettyprint linenums">$('#modal-content').modal(options)</pre>
<h3>Options</h3>
<ul>
@@ -161,7 +176,7 @@ $('#modal-content')
<a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
</div>
<div class="span12 columns">
- <h2>Using boostrap-dropdown.js</h2>
+ <h3>Using boostrap-dropdown.js</h3>
<pre class="prettyprint linenums">$('#topbar').dropdown()</pre>
<h3>Method</h3>
<h4>$().dropdown</h4>
@@ -176,7 +191,7 @@ $('#modal-content')
</script>
<div class="topbar-wrapper">
<div id="topbar-example" class="topbar">
- <div class="fill">
+ <div class="topbar-inner">
<div class="container">
<h3><a href="#">Project Name</a></h3>
<ul>
@@ -264,7 +279,7 @@ $('#modal-content')
<a href="../js/bootstrap-tabs.js" target="_blank" class="btn primary">Download</a>
</div>
<div class="span12 columns">
- <h2>Using boostrap-tabs.js</h2>
+ <h3>Using boostrap-tabs.js</h3>
<pre class="prettyprint linenums">$('.tabs').tabs()</pre>
<h3>Method</h3>
<h4>$().tabs or $().pills</h4>
@@ -331,7 +346,7 @@ Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seita
<a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
</div>
<div class="span12 columns">
- <h2>Using bootstrap-twipsy.js</h2>
+ <h3>Using bootstrap-twipsy.js</h3>
<pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
<h3>Options</h3>
<ul>
@@ -386,7 +401,7 @@ Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seita
<a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
</div>
<div class="span12 columns">
- <h2>Using boostrap-popover.js</h2>
+ <h3>Using boostrap-popover.js</h3>
<pre class="prettyprint linenums">$('#example').popover(options)</pre>
<h3>Options</h3>
<ul>
@@ -440,7 +455,7 @@ Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seita
<a href="../js/bootstrap-alerts.js" target="_blank" class="btn primary">Download</a>
</div>
<div class="span12 columns">
- <h2>Using bootstrap-alert</h2>
+ <h3>Using bootstrap-alerts.js</h3>
<pre class="prettyprint linenums">$(".alert-message").alert()</pre>
<h3>Methods</h3>
<h4>$().alert</h4>
@@ -471,6 +486,18 @@ Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seita
</div>
</section>
- </div>
+
+ </div><!-- /container -->
+
+ <footer class="footer">
+ <div class="container">
+ <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>.<br />
+ Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>.
+ </p>
+ </div>
+ </footer>
+
</body>
-</html> \ No newline at end of file
+</html>