git.roojs.org Git - bootswatch/blob - help/index.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3   <head>
   4     <title>Bootswatch: Help</title>
   5     <meta name="viewport" content="width=device-width, initial-scale=1.0">
   6     <meta charset="utf-8">
   7     <link rel="stylesheet" href="../flatly/bootstrap.min.css" media="screen">
   8     <link rel="stylesheet" href="../bower_components/font-awesome/css/font-awesome.min.css">
   9     <link rel="stylesheet" href="../assets/css/bootswatch.min.css">
  10     <style>
  11
  12       h1 {
  13         margin-top: 2em;
  14       }
  15
  16       code {
  17         background-color: #eee;
  18         color: inherit;
  19       }
  20
  21     </style>
  22     <script type="text/javascript">
  23
  24      var _gaq = _gaq || [];
  25       _gaq.push(['_setAccount', 'UA-23019901-1']);
  26       _gaq.push(['_setDomainName', "bootswatch.com"]);
  27         _gaq.push(['_setAllowLinker', true]);
  28       _gaq.push(['_trackPageview']);
  29
  30      (function() {
  31        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  32        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  33        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  34      })();
  35
  36     </script>
  37   </head>
  38   <body>
  39
  40     <div class="navbar navbar-fixed-top">
  41       <div class="container">
  42         <div class="navbar-header">
  43           <a href="./" class="navbar-brand">Bootswatch</a>
  44           <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#navbar-main">
  45             <span class="icon-bar"></span>
  46             <span class="icon-bar"></span>
  47             <span class="icon-bar"></span>
  48           </button>
  49         </div>
  50         <div class="navbar-collapse collapse" id="navbar-main">
  51           <ul class="nav navbar-nav">
  52             <li class="dropdown">
  53               <a class="dropdown-toggle" data-toggle="dropdown" href="#" id="themes">Themes <span class="caret"></span></a>
  54               <ul class="dropdown-menu" aria-labelledby="themes">
  55                 <li><a tabindex="-1" href="../default/">Default</a></li>
  56                 <li class="divider"></li>
  57                 <li><a tabindex="-1" href="../amelia/">Amelia</a></li>
  58                 <li><a tabindex="-1" href="../cerulean/">Cerulean</a></li>
  59                 <li><a tabindex="-1" href="../cosmo/">Cosmo</a></li>
  60                 <li><a tabindex="-1" href="../cyborg/">Cyborg</a></li>
  61                 <li><a tabindex="-1" href="../flatly/">Flatly</a></li>
  62                 <li><a tabindex="-1" href="../journal/">Journal</a></li>
  63                 <li><a tabindex="-1" href="../readable/">Readable</a></li>
  64                 <li><a tabindex="-1" href="../simplex/">Simplex</a></li>
  65                 <li><a tabindex="-1" href="../slate/">Slate</a></li>
  66                 <li><a tabindex="-1" href="../spacelab/">Spacelab</a></li>
  67                 <li><a tabindex="-1" href="../superhero/">Superhero</a></li>
  68                 <li><a tabindex="-1" href="../united/">United</a></li>
  69               </ul>
  70             </li>
  71             <li class="active">
  72               <a href="./help/">Help</a>
  73             </li>
  74             <li>
  75               <a href="http://news.bootswatch.com">Blog</a>
  76             </li>
  77           </ul>
  78
  79           <ul class="nav navbar-nav navbar-right">
  80             <li><a href="http://builtwithbootstrap.com/" target="_blank">Built With Bootstrap</a></li>
  81             <li><a href="https://wrapbootstrap.com/?ref=bsw" target="_blank">WrapBootstrap</a></li>
  82           </ul>
  83
  84         </div>
  85       </div>
  86     </div>
  87
  88     <div class="container">
  89       <div class="row">
  90         <div class="col-lg-9">
  91
  92             <h1 id="quickstart">Quick Start</h1>
  93             <p>Using a theme is as easy as downloading a CSS file and replacing the one that comes with <a href="http://getbootstrap.com" target="_blank">Bootstrap</a>.</p>
  94
  95             <h1 id="customization">Customization</h1>
  96             <p>To modify a theme or create your own, follow the steps below.</p>
  97             <ol>
  98               <li><p><code>git clone git@github.com:thomaspark/bootswatch.git</code></p></li>
  99               <li><p><code>npm install</code></p></li>
 100               <li><p><code>bower install</code></p></li>
 101               <li>
 102                 <p>Edit <code>variables.less</code> and <code>bootswatch.less</code> in one of the theme directories, or create your own in <code>/custom</code>.</p>
 103               </li>
 104               <li><p>Type <code>grunt swatch:[theme]</code> to build the CSS for a theme, e.g., <code>grunt swatch:amelia</code> for Amelia. Or type <code>grunt swatch</code> to build them all at once.</p></li>
 105             </ol>
 106             <p>Here are additional tips for <a href="http://coding.smashingmagazine.com/2013/03/12/customizing-bootstrap/" target="_blank">customizing Bootstrap</a>.</p>
 107
 108             <h1 id="bookmarklet">Bookmarklet</h1>
 109             <p>Drag <a class="label label-info" href="javascript:(function(e,a,g,h,f,c,b,d)%7Bif(!(f%3De.jQuery)%7C%7Cg%3Ef.fn.jquery%7C%7Ch(f))%7Bc%3Da.createElement(%22script%22)%3Bc.type%3D%22text/javascript%22%3Bc.src%3D%22http://ajax.googleapis.com/ajax/libs/jquery/%22%2Bg%2B%22/jquery.min.js%22%3Bc.onload%3Dc.onreadystatechange%3Dfunction()%7Bif(!b%26%26(!(d%3Dthis.readyState)%7C%7Cd%3D%3D%22loaded%22%7C%7Cd%3D%3D%22complete%22))%7Bh((f%3De.jQuery).noConflict(1),b%3D1)%3Bf(c).remove()%7D%7D%3Ba.documentElement.childNodes%5B0%5D.appendChild(c)%7D%7D)(window,document,%221.3.2%22,function(%24,L)%7Bif(%24(%22.bootswatcher%22)%5B0%5D)%7B%24(%22.bootswatcher%22).remove()%7Delse%7Bvar%20%24e%3D%24(%27%3Cselect%20class%3D%22bootswatcher%22%3E%3Coption%3EAmelia%3C/option%3E%3Coption%3ECerulean%3C/option%3E%3Coption%3ECosmo%3C/option%3E%3Coption%3ECyborg%3C/option%3E%3Coption%3EJournal%3C/option%3E%3Coption%3EReadable%3C/option%3E%3Coption%3ESimplex%3C/option%3E%3Coption%3ESlate%3C/option%3E%3Coption%3ESpacelab%3C/option%3E%3Coption%3ESpruce%3C/option%3E%3Coption%3ESuperhero%3C/option%3E%3Coption%3EUnited%3C/option%3E%3C/select%3E%27)%3Bvar%20l%3D1%2BMath.floor(Math.random()*%24e.children().length)%3B%24e.css(%7B%22z-index%22:%2299999%22,position:%22fixed%22,top:%225px%22,right:%225px%22,opacity:%220.5%22%7D).hover(function()%7B%24(this).css(%22opacity%22,%221%22)%7D,function()%7B%24(this).css(%22opacity%22,%220.5%22)%7D).change(function()%7Bif(!%24(%22link.bootswatcher%22)%5B0%5D)%7B%24(%22head%22).append(%27%3Clink%20rel%3D%22stylesheet%22%20class%3D%22bootswatcher%22%3E%27)%7D%24(%22link.bootswatcher%22).attr(%22href%22,%22http://bootswatch.com/%22%2B%24(this).find(%22:selected%22).text().toLowerCase()%2B%22/bootstrap.min.css%22)%7D).find(%22option:nth-child(%22%2Bl%2B%22)%22).attr(%22selected%22,%22selected%22).end().trigger(%22change%22)%3B%24(%22body%22).append(%24e)%7D%3B%7D)%3B">Bootswatchlet</a> into your bookmarks bar, and use it on Bootstrap-based sites to see how they'd look with a theme.</p>
 110             <p></p>
 111
 112             <h1 id="api">API</h1>
 113             <p>You can use the API to integrate the themes with your platform. Send your request to:</p>
 114             <p><a href="http://api.bootswatch.com/3/">http://api.bootswatch.com/3/</a></p>
 115             <p>This returns the <code>version</code> and a <code>themes</code> array with the following properties: <code>name</code>, <code>description</code>, <code>preview</code>, <code>thumbnail</code>, <code>css</code>, <code>cssMin</code>, <code>less</code>, and <code>lessVariables</code>.</p>
 116             <p>Here's a <a href="http://jsbin.com/oqubil/1/edit" target="_blank">demo</a> with mustache.js templating.</p>
 117
 118         </div>
 119       </div>
 120     </div>
 121
 122
 123     <div class="container">
 124       <footer>
 125         <div class="row">
 126           <div class="col-lg-12">
 127
 128             <ul class="list-unstyled">
 129               <li class="pull-right"><a href="#top">Back to top</a></li>
 130               <li><a href="http://news.bootswatch.com" onclick="pageTracker._link(this.href); return false;">Blog</a></li>
 131               <li><a href="http://feeds.feedburner.com/bootswatch">RSS</a></li>
 132               <li><a href="https://twitter.com/thomashpark">Twitter</a></li>
 133               <li><a href="https://github.com/thomaspark/bootswatch/">GitHub</a></li>
 134               <li><a href="../help/#api">API</a></li>
 135               <li><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=F22JEM3Q78JC2">Donate</a></li>
 136             </ul>
 137             <p>Made by <a href="http://thomaspark.me">Thomas Park</a>. Contact him at <a href="mailto:hello@thomaspark.me">hello@thomaspark.me</a>.</p>
 138             <p>Code licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.</p>
 139             <p>Based on <a href="http://getbootstrap.com">Bootstrap</a>. Icons from <a href="http://fortawesome.github.io/Font-Awesome/">Font Awesome</a>. Web fonts from <a href="http://www.google.com/webfonts">Google</a>. Favicon by <a href="https://twitter.com/geraldhiller">Gerald Hiller</a>.</p>
 140
 141           </div>
 142         </div>
 143
 144       </footer>
 145
 146     </div>
 147
 148
 149     <script src="../bower_components/jquery/jquery.min.js"></script>
 150     <script src="../bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
 151     <script src="../assets/js/bootswatch.js"></script>
 152     <script type="text/javascript">
 153       !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
 154     </script>
 155   </body>
 156 </html>