diff options
| author | Mark Otto <[email protected]> | 2012-07-09 22:25:00 -0700 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2012-07-09 22:25:00 -0700 |
| commit | 6f8226a393537ce349ce7d211539bb6f699afa8d (patch) | |
| tree | 9be0ea1499c541a1812f18d06e6f1589631e08f1 /docs | |
| parent | 64e87a85f5e17e3cf603b97e21d58b077060e7b2 (diff) | |
| download | bootstrap-6f8226a393537ce349ce7d211539bb6f699afa8d.tar.xz bootstrap-6f8226a393537ce349ce7d211539bb6f699afa8d.zip | |
update Extend docs page to include side nav and spec out next section for extending with static assets
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/extend.html | 154 | ||||
| -rw-r--r-- | docs/templates/pages/extend.mustache | 154 |
2 files changed, 166 insertions, 142 deletions
diff --git a/docs/extend.html b/docs/extend.html index ccd512260..5745c83b0 100644 --- a/docs/extend.html +++ b/docs/extend.html @@ -68,96 +68,108 @@ <div class="container"> -<!-- Masthead +<!-- Subhead ================================================== --> <header class="jumbotron subhead" id="overview"> <h1>Extending Bootstrap</h1> - <p class="lead">Extend Bootstrap with <a href="http://lesscss.org" target="_blank">LESS</a>, a CSS preprocessor, to take advantage of the variables, mixins, and more used to build Bootstrap's CSS.</p> - <div class="navbar navbar-subnav"> - <div class="navbar-inner"> - <ul class="nav"> - <li><a href="#builtWith">Built with Less</a></li> - <li><a href="#compiling">Compiling Bootstrap</a></li> - </ul> - </div> - </div> + <p class="lead">Extend Bootstrap to take advantage of included styles and components, as well as LESS variables and mixins.</p> </header> -<!-- BUILT WITH LESS +<!-- Docs nav ================================================== --> -<section id="builtWith"> - <div class="page-header"> - <h1>Built with LESS</h1> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#built-with-less">Built with LESS</a></li> + <li><a href="#compiling">Compiling Bootstrap</a></li> + <li><a href="#static-assets">Use as static assets</a></li> + </ul> </div> + <div class="span9"> - <h3>Why LESS?</h3> - <p>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> - <h3>What's included?</h3> - <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> - <h3>Learn more</h3> - <img style="float: right; height: 36px;" src="assets/img/less-logo-large.png" alt="LESS CSS"> - <p>Visit the official website at <a href="http://lesscss.org">http://lesscss.org</a> to learn more.</p> + <!-- BUILT WITH LESS + ================================================== --> + <section id="built-with-less"> + <div class="page-header"> + <h1>Built with LESS</h1> + </div> - <h3><a href="#variables">Variables</a></h3> - <p>Managing colors and pixel values in CSS can be a bit of a pain, usually full of copy and paste. Not with LESS though—assign colors or pixel values as variables and change them once.</p> + <h3>Why LESS?</h3> + <p>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> - <h3><a href="#mixins">Mixins</a></h3> - <p>Those three border-radius declarations you need to make in regular ol' CSS? Now they're down to one line with the help of mixins, snippets of code you can reuse anywhere.</p> + <h3>What's included?</h3> + <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> - <h3>Operations</h3> - <p>Make your grid, leading, and more super flexible by doing the math on the fly with operations. Multiply, divide, add, and subtract your way to CSS sanity.</p> -</section> + <h3>Learn more</h3> + <img style="float: right; height: 36px;" src="assets/img/less-logo-large.png" alt="LESS CSS"> + <p>Visit the official website at <a href="http://lesscss.org">http://lesscss.org</a> to learn more.</p> + </section> -<!-- COMPILING LESS AND BOOTSTRAP -================================================== --> -<section id="compiling"> - <div class="page-header"> - <h1>Compiling Bootstrap with LESS</h1> - </div> - <div class="alert alert-info"> - <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. - </div> + <!-- COMPILING LESS AND BOOTSTRAP + ================================================== --> + <section id="compiling"> + <div class="page-header"> + <h1>Compiling Bootstrap with LESS</h1> + </div> + <div class="alert alert-info"> + <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. + </div> + + <h2>Tools for compiling</h2> + + <h3>Node with makefile</h3> + <p>Install the LESS command line compiler, JSHint, Recess, and uglify-js globally with npm by running the following command:</p> + <pre>$ npm install -g less jshint recess uglify-js</pre> + <p>Once installed just run <code>make</code> from the root of your bootstrap directory and you're all set.</p> + <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> - <h2>Tools for compiling</h2> - - <h3>Node with makefile</h3> - <p>Install the LESS command line compiler, JSHint, Recess, and uglify-js globally with npm by running the following command:</p> - <pre>$ npm install -g less jshint recess uglify-js</pre> - <p>Once installed just run <code>make</code> from the root of your bootstrap directory and you're all set.</p> - <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> - - <h3>Command line</h3> - <p>Install the LESS command line tool via Node and run the following command:</p> - <pre>$ lessc ./less/bootstrap.less > bootstrap.css</pre> - <p>Be sure to include <code>--compress</code> in that command if you're trying to save some bytes!</p> - - <h3>Javascript</h3> - <p><a href="http://lesscss.org/">Download the latest Less.js</a> and include the path to it (and Bootstrap) in the <code><head></code>.</p> -<pre class="prettyprint"> -<link rel="stylesheet/less" href="/path/to/bootstrap.less"> -<script src="/path/to/less.js"></script> -</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> - - <h3>Unofficial Mac app</h3> - <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> - - <h3>More Mac apps</h3> - <h4><a href="http://crunchapp.net/" target="_blank">Crunch</a></h4> - <p>Crunch is a great looking LESS editor and compiler built on Adobe Air.</p> - <h4><a href="http://incident57.com/codekit/" target="_blank">CodeKit</a></h4> - <p>Created by the same guy as the unofficial Mac app, CodeKit is a Mac app that compiles LESS, SASS, Stylus, and CoffeeScript.</p> - <h4><a href="http://wearekiss.com/simpless" target="_blank">Simpless</a></h4> - <p>Mac, Linux, and PC 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> - -</section> + <h3>Command line</h3> + <p>Install the LESS command line tool via Node and run the following command:</p> + <pre>$ lessc ./less/bootstrap.less > bootstrap.css</pre> + <p>Be sure to include <code>--compress</code> in that command if you're trying to save some bytes!</p> + + <h3>Javascript</h3> + <p><a href="http://lesscss.org/">Download the latest Less.js</a> and include the path to it (and Bootstrap) in the <code><head></code>.</p> + <pre class="prettyprint"> + <link rel="stylesheet/less" href="/path/to/bootstrap.less"> + <script src="/path/to/less.js"></script> + </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> + + <h3>Unofficial Mac app</h3> + <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> + + <h3>More Mac apps</h3> + <h4><a href="http://crunchapp.net/" target="_blank">Crunch</a></h4> + <p>Crunch is a great looking LESS editor and compiler built on Adobe Air.</p> + <h4><a href="http://incident57.com/codekit/" target="_blank">CodeKit</a></h4> + <p>Created by the same guy as the unofficial Mac app, CodeKit is a Mac app that compiles LESS, SASS, Stylus, and CoffeeScript.</p> + <h4><a href="http://wearekiss.com/simpless" target="_blank">Simpless</a></h4> + <p>Mac, Linux, and PC 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> + + </section> + + + + <!-- Static assets + ================================================== --> + <section id="static-assets"> + <div class="page-header"> + <h1>Use as static assets</h1> + </div> + <p>...</p> + </section> + + + </div> +</div> <!-- Footer diff --git a/docs/templates/pages/extend.mustache b/docs/templates/pages/extend.mustache index aae99f765..aca6f06aa 100644 --- a/docs/templates/pages/extend.mustache +++ b/docs/templates/pages/extend.mustache @@ -1,90 +1,102 @@ -<!-- Masthead +<!-- Subhead ================================================== --> <header class="jumbotron subhead" id="overview"> <h1>{{_i}}Extending Bootstrap{{/i}}</h1> - <p class="lead">{{_i}}Extend Bootstrap with <a href="http://lesscss.org" target="_blank">LESS</a>, a CSS preprocessor, to take advantage of the variables, mixins, and more used to build Bootstrap's CSS.{{/i}}</p> - <div class="navbar navbar-subnav"> - <div class="navbar-inner"> - <ul class="nav"> - <li><a href="#builtWith">{{_i}}Built with Less{{/i}}</a></li> - <li><a href="#compiling">{{_i}}Compiling Bootstrap{{/i}}</a></li> - </ul> - </div> - </div> + <p class="lead">{{_i}}Extend Bootstrap to take advantage of included styles and components, as well as LESS variables and mixins.{{/i}}</p> </header> -<!-- BUILT WITH LESS +<!-- Docs nav ================================================== --> -<section id="builtWith"> - <div class="page-header"> - <h1>{{_i}}Built with LESS{{/i}}</h1> +<div class="row"> + <div class="span3 bs-docs-sidebar"> + <ul class="nav nav-list bs-docs-sidenav"> + <li><a href="#built-with-less">{{_i}}Built with LESS{{/i}}</a></li> + <li><a href="#compiling">{{_i}}Compiling Bootstrap{{/i}}</a></li> + <li><a href="#static-assets">{{_i}}Use as static assets{{/i}}</a></li> + </ul> </div> + <div class="span9"> - <h3>{{_i}}Why LESS?{{/i}}</h3> - <p>{{_i}}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.{{/i}}</p> - <h3>{{_i}}What's included?{{/i}}</h3> - <p>{{_i}}As an extension of CSS, LESS includes variables, mixins for reusable snippets of code, operations for simple math, nesting, and even color functions.{{/i}}</p> - <h3>{{_i}}Learn more{{/i}}</h3> - <img style="float: right; height: 36px;" src="assets/img/less-logo-large.png" alt="LESS CSS"> - <p>{{_i}}Visit the official website at <a href="http://lesscss.org">http://lesscss.org</a> to learn more.{{/i}}</p> + <!-- BUILT WITH LESS + ================================================== --> + <section id="built-with-less"> + <div class="page-header"> + <h1>{{_i}}Built with LESS{{/i}}</h1> + </div> - <h3><a href="#variables">{{_i}}Variables{{/i}}</a></h3> - <p>{{_i}}Managing colors and pixel values in CSS can be a bit of a pain, usually full of copy and paste. Not with LESS though—assign colors or pixel values as variables and change them once.{{/i}}</p> + <h3>{{_i}}Why LESS?{{/i}}</h3> + <p>{{_i}}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.{{/i}}</p> - <h3><a href="#mixins">{{_i}}Mixins{{/i}}</a></h3> - <p>{{_i}}Those three border-radius declarations you need to make in regular ol' CSS? Now they're down to one line with the help of mixins, snippets of code you can reuse anywhere.{{/i}}</p> + <h3>{{_i}}What's included?{{/i}}</h3> + <p>{{_i}}As an extension of CSS, LESS includes variables, mixins for reusable snippets of code, operations for simple math, nesting, and even color functions.{{/i}}</p> - <h3>{{_i}}Operations{{/i}}</h3> - <p>{{_i}}Make your grid, leading, and more super flexible by doing the math on the fly with operations. Multiply, divide, add, and subtract your way to CSS sanity.{{/i}}</p> -</section> + <h3>{{_i}}Learn more{{/i}}</h3> + <img style="float: right; height: 36px;" src="assets/img/less-logo-large.png" alt="LESS CSS"> + <p>{{_i}}Visit the official website at <a href="http://lesscss.org">http://lesscss.org</a> to learn more.{{/i}}</p> + </section> -<!-- COMPILING LESS AND BOOTSTRAP -================================================== --> -<section id="compiling"> - <div class="page-header"> - <h1>{{_i}}Compiling Bootstrap with LESS{{/i}}</h1> - </div> - <div class="alert alert-info"> - {{_i}}<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.{{/i}} - </div> + <!-- COMPILING LESS AND BOOTSTRAP + ================================================== --> + <section id="compiling"> + <div class="page-header"> + <h1>{{_i}}Compiling Bootstrap with LESS{{/i}}</h1> + </div> + <div class="alert alert-info"> + {{_i}}<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.{{/i}} + </div> + + <h2>{{_i}}Tools for compiling{{/i}}</h2> + + <h3>{{_i}}Node with makefile{{/i}}</h3> + <p>{{_i}}Install the LESS command line compiler, JSHint, Recess, and uglify-js globally with npm by running the following command:{{/i}}</p> + <pre>$ npm install -g less jshint recess uglify-js</pre> + <p>{{_i}}Once installed just run <code>make</code> from the root of your bootstrap directory and you're all set.{{/i}}</p> + <p>{{_i}}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).{{/i}}</p> + + <h3>{{_i}}Command line{{/i}}</h3> + <p>{{_i}}Install the LESS command line tool via Node and run the following command:{{/i}}</p> + <pre>$ lessc ./less/bootstrap.less > bootstrap.css</pre> + <p>{{_i}}Be sure to include <code>--compress</code> in that command if you're trying to save some bytes!{{/i}}</p> + + <h3>{{_i}}Javascript{{/i}}</h3> + <p>{{_i}}<a href="http://lesscss.org/">Download the latest Less.js</a> and include the path to it (and Bootstrap) in the <code><head></code>.{{/i}}</p> + <pre class="prettyprint"> + <link rel="stylesheet/less" href="/path/to/bootstrap.less"> + <script src="/path/to/less.js"></script> + </pre> + <p>{{_i}}To recompile the .less files, just save them and reload your page. Less.js compiles them and stores them in local storage.{{/i}}</p> + + <h3>{{_i}}Unofficial Mac app{{/i}}</h3> + <p>{{_i}}<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.{{/i}}</p> + <p>{{_i}}If you like, you can toggle preferences in the app for automatic minifying and which directory the compiled files end up in.{{/i}}</p> + + <h3>{{_i}}More Mac apps{{/i}}</h3> + <h4><a href="http://crunchapp.net/" target="_blank">Crunch</a></h4> + <p>{{_i}}Crunch is a great looking LESS editor and compiler built on Adobe Air.{{/i}}</p> + <h4><a href="http://incident57.com/codekit/" target="_blank">CodeKit</a></h4> + <p>{{_i}}Created by the same guy as the unofficial Mac app, CodeKit is a Mac app that compiles LESS, SASS, Stylus, and CoffeeScript.{{/i}}</p> + <h4><a href="http://wearekiss.com/simpless" target="_blank">Simpless</a></h4> + <p>{{_i}}Mac, Linux, and PC 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>.{{/i}}</p> + + </section> + + + + <!-- Static assets + ================================================== --> + <section id="static-assets"> + <div class="page-header"> + <h1>{{_i}}Use as static assets{{/i}}</h1> + </div> + <p>...</p> + </section> + - <h2>{{_i}}Tools for compiling{{/i}}</h2> - - <h3>{{_i}}Node with makefile{{/i}}</h3> - <p>{{_i}}Install the LESS command line compiler, JSHint, Recess, and uglify-js globally with npm by running the following command:{{/i}}</p> - <pre>$ npm install -g less jshint recess uglify-js</pre> - <p>{{_i}}Once installed just run <code>make</code> from the root of your bootstrap directory and you're all set.{{/i}}</p> - <p>{{_i}}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).{{/i}}</p> - - <h3>{{_i}}Command line{{/i}}</h3> - <p>{{_i}}Install the LESS command line tool via Node and run the following command:{{/i}}</p> - <pre>$ lessc ./less/bootstrap.less > bootstrap.css</pre> - <p>{{_i}}Be sure to include <code>--compress</code> in that command if you're trying to save some bytes!{{/i}}</p> - - <h3>{{_i}}Javascript{{/i}}</h3> - <p>{{_i}}<a href="http://lesscss.org/">Download the latest Less.js</a> and include the path to it (and Bootstrap) in the <code><head></code>.{{/i}}</p> -<pre class="prettyprint"> -<link rel="stylesheet/less" href="/path/to/bootstrap.less"> -<script src="/path/to/less.js"></script> -</pre> - <p>{{_i}}To recompile the .less files, just save them and reload your page. Less.js compiles them and stores them in local storage.{{/i}}</p> - - <h3>{{_i}}Unofficial Mac app{{/i}}</h3> - <p>{{_i}}<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.{{/i}}</p> - <p>{{_i}}If you like, you can toggle preferences in the app for automatic minifying and which directory the compiled files end up in.{{/i}}</p> - - <h3>{{_i}}More Mac apps{{/i}}</h3> - <h4><a href="http://crunchapp.net/" target="_blank">Crunch</a></h4> - <p>{{_i}}Crunch is a great looking LESS editor and compiler built on Adobe Air.{{/i}}</p> - <h4><a href="http://incident57.com/codekit/" target="_blank">CodeKit</a></h4> - <p>{{_i}}Created by the same guy as the unofficial Mac app, CodeKit is a Mac app that compiles LESS, SASS, Stylus, and CoffeeScript.{{/i}}</p> - <h4><a href="http://wearekiss.com/simpless" target="_blank">Simpless</a></h4> - <p>{{_i}}Mac, Linux, and PC 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>.{{/i}}</p> - -</section> + </div>{{! /span9 }} +</div>{{! row}} |
