PageRenderTime 26ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/extend.html

https://bitbucket.org/burnsjeremy/bootstrap
HTML | 286 lines | 217 code | 46 blank | 23 comment | 0 complexity | e14b6d39f804c96649090d6c69904d0f MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3.   <head>
    4. 

  4.     <meta charset="utf-8">
    5. 

  5.     <title>Extend · Twitter Bootstrap</title>
    6. 

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0">
    7. 

  7.     <meta name="description" content="">
    8. 

  8.     <meta name="author" content="">
    9. 

  9. 

  10.     <!-- Le styles -->
    11. 

  11.     <link href="assets/css/bootstrap.css" rel="stylesheet">
    12. 

  12.     <link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
    13. 

  13.     <link href="assets/css/docs.css" rel="stylesheet">
    14. 

  14.     <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
    15. 

  15. 

  16.     <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
    17. 

  17.     <!--[if lt IE 9]>
    18. 

  18.       <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    19. 

  19.     <![endif]-->
    20. 

  20. 

  21.     <!-- Le fav and touch icons -->
    22. 

  22.     <link rel="shortcut icon" href="assets/ico/favicon.ico">
    23. 

  23.     <link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/apple-touch-icon-144-precomposed.png">
    24. 

  24.     <link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/apple-touch-icon-114-precomposed.png">
    25. 

  25.     <link rel="apple-touch-icon-precomposed" sizes="72x72" href="assets/ico/apple-touch-icon-72-precomposed.png">
    26. 

  26.     <link rel="apple-touch-icon-precomposed" href="assets/ico/apple-touch-icon-57-precomposed.png">
    27. 

  27. 

  28.   </head>
    29. 

  29. 

  30.   <body data-spy="scroll" data-target=".bs-docs-sidebar">
    31. 

  31. 

  32.     <!-- Navbar
    33. 

  33.     ================================================== -->
    34. 

  34.     <div class="navbar navbar-inverse navbar-fixed-top">
    35. 

  35.       <div class="navbar-inner">
    36. 

  36.         <div class="container">
    37. 

  37.           <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
    38. 

  38.             <span class="icon-bar"></span>
    39. 

  39.             <span class="icon-bar"></span>
    40. 

  40.             <span class="icon-bar"></span>
    41. 

  41.           </button>
    42. 

  42.           <a class="brand" href="./index.html">Bootstrap</a>
    43. 

  43.           <div class="nav-collapse collapse">
    44. 

  44.             <ul class="nav">
    45. 

  45.               <li class="">
    46. 

  46.                 <a href="./index.html">Home</a>
    47. 

  47.               </li>
    48. 

  48.               <li class="">
    49. 

  49.                 <a href="./getting-started.html">Get started</a>
    50. 

  50.               </li>
    51. 

  51.               <li class="">
    52. 

  52.                 <a href="./scaffolding.html">Scaffolding</a>
    53. 

  53.               </li>
    54. 

  54.               <li class="">
    55. 

  55.                 <a href="./base-css.html">Base CSS</a>
    56. 

  56.               </li>
    57. 

  57.               <li class="">
    58. 

  58.                 <a href="./components.html">Components</a>
    59. 

  59.               </li>
    60. 

  60.               <li class="">
    61. 

  61.                 <a href="./javascript.html">Javascript</a>
    62. 

  62.               </li>
    63. 

  63.               <li class="">
    64. 

  64.                 <a href="./customize.html">Customize</a>
    65. 

  65.               </li>
    66. 

  66.             </ul>
    67. 

  67.           </div>
    68. 

  68.         </div>
    69. 

  69.       </div>
    70. 

  70.     </div>
    71. 

  71. 

  72. <!-- Subhead
    73. 

  73. ================================================== -->
    74. 

  74. <header class="jumbotron subhead" id="overview">
    75. 

  75.   <div class="container">
    76. 

  76.     <h1>Extending Bootstrap</h1>
    77. 

  77.     <p class="lead">Extend Bootstrap to take advantage of included styles and components, as well as LESS variables and mixins.</p>
    78. 

  78.   <div>
    79. 

  79. </header>
    80. 

  80. 

  81.   <div class="container">
    82. 

  82. 

  83.     <!-- Docs nav
    84. 

  84.     ================================================== -->
    85. 

  85.     <div class="row">
    86. 

  86.       <div class="span3 bs-docs-sidebar">
    87. 

  87.         <ul class="nav nav-list bs-docs-sidenav">
    88. 

  88.           <li><a href="#built-with-less"><i class="icon-chevron-right"></i> Built with LESS</a></li>
    89. 

  89.           <li><a href="#compiling"><i class="icon-chevron-right"></i> Compiling Bootstrap</a></li>
    90. 

  90.           <li><a href="#static-assets"><i class="icon-chevron-right"></i> Use as static assets</a></li>
    91. 

  91.         </ul>
    92. 

  92.       </div>
    93. 

  93.       <div class="span9">
    94. 

  94. 

  95. 

  96. 

  97.         <!-- BUILT WITH LESS
    98. 

  98.         ================================================== -->
    99. 

  99.         <section id="built-with-less">
    100. 

  100.           <div class="page-header">
    101. 

  101.             <h1>Built with LESS</h1>
    102. 

  102.           </div>
    103. 

  103. 

  104.           <img style="float: right; height: 36px; margin: 10px 20px 20px" src="assets/img/less-logo-large.png" alt="LESS CSS">
    105. 

  105.           <p class="lead">Bootstrap is made with LESS at its core, a dynamic stylesheet language created by our good friend, <a href="http://cloudhead.io">Alexis Sellier</a>. It makes developing systems-based CSS faster, easier, and more fun.</p>
    106. 

  106. 

  107.           <h3>Why LESS?</h3>
    108. 

  108.           <p>One of Bootstrap's creators wrote a quick <a href="http://www.wordsbyf.at/2012/03/08/why-less/">blog post about this</a>, summarized here:</p>
    109. 

  109.           <ul>
    110. 

  110.             <li>Bootstrap compiles faster ~6x faster with Less compared to Sass</li>
    111. 

  111.             <li>Less is written in JavaScript, making it easier to us to dive in and patch compared to Ruby with Sass.</li>
    112. 

  112.             <li>Less is more; we want to feel like we're writing CSS and making Bootstrap approachable to all.</li>
    113. 

  113.           </ul>
    114. 

  114. 

  115.           <h3>What's included?</h3>
    116. 

  116.           <p>As an extension of CSS, LESS includes variables, mixins for reusable snippets of code, operations for simple math, nesting, and even color functions.</p>
    117. 

  117. 

  118.           <h3>Learn more</h3>
    119. 

  119.           <p>Visit the official website at <a href="http://lesscss.org">http://lesscss.org</a> to learn more.</p>
    120. 

  120.         </section>
    121. 

  121. 

  122. 

  123. 

  124.         <!-- COMPILING LESS AND BOOTSTRAP
    125. 

  125.         ================================================== -->
    126. 

  126.         <section id="compiling">
    127. 

  127.           <div class="page-header">
    128. 

  128.             <h1>Compiling Bootstrap with Less</h1>
    129. 

  129.           </div>
    130. 

  130. 

  131.           <p class="lead">Since our CSS is written with Less and utilizes variables and mixins, it needs to be compiled for final production implementation. Here's how.</p>
    132. 

    133. 

  133.           <div class="alert alert-info">
    134. 

  134.             <strong>Note:</strong> If you're submitting a pull request to GitHub with modified CSS, you <strong>must</strong> recompile the CSS via any of these methods.
    135. 

  135.           </div>
    136. 

  136. 

  137.           <h2>Tools for compiling</h2>
    138. 

  138. 

  139.           <h3>Node with makefile</h3>
    140. 

  140.           <p>Install the LESS command line compiler, JSHint, Recess, and uglify-js globally with npm by running the following command:</p>
    141. 

  141.           <pre>$ npm install -g less jshint recess uglify-js</pre>
    142. 

  142.           <p>Once installed just run <code>make</code> from the root of your bootstrap directory and you're all set.</p>
    143. 

  143.           <p>Additionally, if you have <a href="https://github.com/mynyml/watchr">watchr</a> installed, you may run <code>make watch</code> to have bootstrap automatically rebuilt every time you edit a file in the bootstrap lib (this isn't required, just a convenience method).</p>
    144. 

    145. 

  145.           <h3>Command line</h3>
    146. 

  146.           <p>Install the LESS command line tool via Node and run the following command:</p>
    147. 

  147.           <pre>$ lessc ./less/bootstrap.less > bootstrap.css</pre>
    148. 

  148.           <p>Be sure to include <code>--compress</code> in that command if you're trying to save some bytes!</p>
    149. 

    150. 

  150.           <h3>Javascript</h3>
    151. 

  151.           <p><a href="http://lesscss.org/">Download the latest Less.js</a> and include the path to it (and Bootstrap) in the <code>&lt;head&gt;</code>.</p>
    152. 

  152. <pre class="prettyprint">
    153. 

  153. &lt;link rel="stylesheet/less" href="/path/to/bootstrap.less"&gt;
    154. 

  154. &lt;script src="/path/to/less.js"&gt;&lt;/script&gt;
    155. 

  155. </pre>
    156. 

  156.           <p>To recompile the .less files, just save them and reload your page. Less.js compiles them and stores them in local storage.</p>
    157. 

  157. 

  158.           <h3>Unofficial Mac app</h3>
    159. 

  159.           <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. If you like, you can toggle preferences in the app for automatic minifying and which directory the compiled files end up in.</p>
    160. 

  160. 

  161.           <h3>More apps</h3>
    162. 

  162.           <h4><a href="http://crunchapp.net/" target="_blank">Crunch</a></h4>
    163. 

  163.           <p>Crunch is a great looking LESS editor and compiler built on Adobe Air.</p>
    164. 

  164.           <h4><a href="http://incident57.com/codekit/" target="_blank">CodeKit</a></h4>
    165. 

  165.           <p>Created by the same guy as the unofficial Mac app, CodeKit is a Mac app that compiles LESS, SASS, Stylus, and CoffeeScript.</p>
    166. 

  166.           <h4><a href="http://wearekiss.com/simpless" target="_blank">Simpless</a></h4>
    167. 

  167.           <p>Mac, Linux, and Windows app for drag and drop compiling of LESS files. Plus, the <a href="https://github.com/Paratron/SimpLESS" target="_blank">source code is on GitHub</a>.</p>
    168. 

  168. 

  169.         </section>
    170. 

  170. 

  171. 

  172. 

  173.         <!-- Static assets
    174. 

  174.         ================================================== -->
    175. 

  175.         <section id="static-assets">
    176. 

  176.           <div class="page-header">
    177. 

  177.             <h1>Use as static assets</h1>
    178. 

  178.           </div>
    179. 

  179.           <p class="lead"><a href="./getting-started.html">Quickly start</a> any web project by dropping in the compiled or minified CSS and JS. Layer on custom styles separately for easy upgrades and maintenance moving forward.</p>
    180. 

  180. 

  181.           <h3>Setup file structure</h3>
    182. 

  182.           <p>Download the latest compiled Bootstrap and place into your project. For example, you might have something like this:</p>
    183. 

  183. <pre class="prettyprint">
    184. 

  184.   app/
    185. 

  185.   ├── layouts/
    186. 

  186.   └── templates/
    187. 

  187.   public/
    188. 

  188.   ├── css/
    189. 

  189.   │   ├── bootstrap.min.css
    190. 

  190.   ├── js/
    191. 

  191.   │   ├── bootstrap.min.js
    192. 

  192.   └── img/
    193. 

  193.       ├── glyphicons-halflings.png
    194. 

  194.       └── glyphicons-halflings-white.png
    195. 

  195. </pre>
    196. 

  196. 

  197.           <h3>Utilize starter template</h3>
    198. 

  198.           <p>Copy the following base HTML to get started.</p>
    199. 

  199. <pre class="prettyprint linenums">
    200. 

  200. &lt;html&gt;
    201. 

  201.   &lt;head&gt;
    202. 

  202.     &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
    203. 

  203.     &lt;!-- Bootstrap --&gt;
    204. 

  204.     &lt;link href="public/css/bootstrap.min.css" rel="stylesheet"&gt;
    205. 

  205.   &lt;/head&gt;
    206. 

  206.   &lt;body&gt;
    207. 

  207.     &lt;h1&gt;Hello, world!&lt;/h1&gt;
    208. 

  208.     &lt;!-- Bootstrap --&gt;
    209. 

  209.     &lt;script src="public/js/bootstrap.min.js"&gt;&lt;/script&gt;
    210. 

  210.   &lt;/body&gt;
    211. 

  211. &lt;/html&gt;
    212. 

  212. </pre>
    213. 

  213. 

  214.           <h3>Layer on custom code</h3>
    215. 

  215.           <p>Work in your custom CSS, JS, and more as necessary to make Bootstrap your own with your own separate CSS and JS files.</p>
    216. 

  216. <pre class="prettyprint linenums">
    217. 

  217. &lt;html&gt;
    218. 

  218.   &lt;head&gt;
    219. 

  219.     &lt;title&gt;Bootstrap 101 Template&lt;/title&gt;
    220. 

  220.     &lt;!-- Bootstrap --&gt;
    221. 

  221.     &lt;link href="public/css/bootstrap.min.css" rel="stylesheet"&gt;
    222. 

  222.     &lt;!-- Project --&gt;
    223. 

  223.     &lt;link href="public/css/application.css" rel="stylesheet"&gt;
    224. 

  224.   &lt;/head&gt;
    225. 

  225.   &lt;body&gt;
    226. 

  226.     &lt;h1&gt;Hello, world!&lt;/h1&gt;
    227. 

  227.     &lt;!-- Bootstrap --&gt;
    228. 

  228.     &lt;script src="public/js/bootstrap.min.js"&gt;&lt;/script&gt;
    229. 

  229.     &lt;!-- Project --&gt;
    230. 

  230.     &lt;script src="public/js/application.js"&gt;&lt;/script&gt;
    231. 

  231.   &lt;/body&gt;
    232. 

  232. &lt;/html&gt;
    233. 

  233. </pre>
    234. 

  234. 

  235.         </section>
    236. 

  236. 

  237.       </div>
    238. 

  238.     </div>
    239. 

  239. 

  240.   </div>
    241. 

  241. 

  242. 

  243. 

  244.     <!-- Footer
    245. 

  245.     ================================================== -->
    246. 

  246.     <footer class="footer">
    247. 

  247.       <div class="container">
    248. 

  248.         <p class="pull-right"><a href="#">Back to top</a></p>
    249. 

  249.         <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>
    250. 

  250.         <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>
    251. 

  251.         <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>
    252. 

  252.         <ul class="footer-links">
    253. 

  253.           <li><a href="http://blog.getbootstrap.com">Read the blog</a></li>
    254. 

  254.           <li><a href="https://github.com/twitter/bootstrap/issues?state=open">Submit issues</a></li>
    255. 

  255.           <li><a href="https://github.com/twitter/bootstrap/wiki">Roadmap and changelog</a></li>
    256. 

  256.         </ul>
    257. 

  257.       </div>
    258. 

  258.     </footer>
    259. 

  259. 

  260. 

  261. 

  262.     <!-- Le javascript
    263. 

  263.     ================================================== -->
    264. 

  264.     <!-- Placed at the end of the document so the pages load faster -->
    265. 

  265.     <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
    266. 

  266.     <script src="assets/js/jquery.js"></script>
    267. 

  267.     <script src="assets/js/google-code-prettify/prettify.js"></script>
    268. 

  268.     <script src="assets/js/bootstrap-transition.js"></script>
    269. 

  269.     <script src="assets/js/bootstrap-alert.js"></script>
    270. 

  270.     <script src="assets/js/bootstrap-modal.js"></script>
    271. 

  271.     <script src="assets/js/bootstrap-dropdown.js"></script>
    272. 

  272.     <script src="assets/js/bootstrap-scrollspy.js"></script>
    273. 

  273.     <script src="assets/js/bootstrap-tab.js"></script>
    274. 

  274.     <script src="assets/js/bootstrap-tooltip.js"></script>
    275. 

  275.     <script src="assets/js/bootstrap-popover.js"></script>
    276. 

  276.     <script src="assets/js/bootstrap-button.js"></script>
    277. 

  277.     <script src="assets/js/bootstrap-collapse.js"></script>
    278. 

  278.     <script src="assets/js/bootstrap-carousel.js"></script>
    279. 

  279.     <script src="assets/js/bootstrap-typeahead.js"></script>
    280. 

  280.     <script src="assets/js/bootstrap-affix.js"></script>
    281. 

  281.     <script src="assets/js/application.js"></script>
    282. 

  282. 

  283. 

  284. 

  285.   </body>
    286. 

  286. </html>
    287. 

  287.