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.css" media="screen">
   8     <link rel="stylesheet" href="../assets/css/bootswatch.min.css">
   9     <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
  10     <!--[if lt IE 9]>
  11       <script src="../bower_components/html5shiv/dist/html5shiv.js"></script>
  12       <script src="../bower_components/respond/dest/respond.min.js"></script>
  13     <![endif]-->
  14     <style>
  15
  16       h1 {
  17         margin-top: 2em;
  18       }
  19
  20       code {
  21         background-color: #eee;
  22         color: inherit;
  23       }
  24
  25     </style>
  26     <script type="text/javascript">
  27
  28      var _gaq = _gaq || [];
  29       _gaq.push(['_setAccount', 'UA-23019901-1']);
  30       _gaq.push(['_setDomainName', "bootswatch.com"]);
  31         _gaq.push(['_setAllowLinker', true]);
  32       _gaq.push(['_trackPageview']);
  33
  34      (function() {
  35        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  36        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  37        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  38      })();
  39
  40     </script>
  41   </head>
  42   <body>
  43
  44     <div class="navbar navbar-default navbar-fixed-top">
  45       <div class="container">
  46         <div class="navbar-header">
  47           <a href="../" class="navbar-brand">Bootswatch</a>
  48           <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#navbar-main">
  49             <span class="icon-bar"></span>
  50             <span class="icon-bar"></span>
  51             <span class="icon-bar"></span>
  52           </button>
  53         </div>
  54         <div class="navbar-collapse collapse" id="navbar-main">
  55           <ul class="nav navbar-nav">
  56             <li class="dropdown">
  57               <a class="dropdown-toggle" data-toggle="dropdown" href="#" id="themes">Themes <span class="caret"></span></a>
  58               <ul class="dropdown-menu" aria-labelledby="themes">
  59                 <li><a tabindex="-1" href="../default/">Default</a></li>
  60                 <li class="divider"></li>
  61                 <li><a tabindex="-1" href="../amelia/">Amelia</a></li>
  62                 <li><a tabindex="-1" href="../cerulean/">Cerulean</a></li>
  63                 <li><a tabindex="-1" href="../cosmo/">Cosmo</a></li>
  64                 <li><a tabindex="-1" href="../cyborg/">Cyborg</a></li>
  65                 <li><a tabindex="-1" href="../flatly/">Flatly</a></li>
  66                 <li><a tabindex="-1" href="../journal/">Journal</a></li>
  67                 <li><a tabindex="-1" href="../readable/">Readable</a></li>
  68                 <li><a tabindex="-1" href="../simplex/">Simplex</a></li>
  69                 <li><a tabindex="-1" href="../slate/">Slate</a></li>
  70                 <li><a tabindex="-1" href="../spacelab/">Spacelab</a></li>
  71                 <li><a tabindex="-1" href="../united/">United</a></li>
  72                 <li><a tabindex="-1" href="../yeti/">Yeti</a></li>
  73               </ul>
  74             </li>
  75             <li class="active">
  76               <a href="../help/">Help</a>
  77             </li>
  78             <li>
  79               <a href="http://news.bootswatch.com">Blog</a>
  80             </li>
  81           </ul>
  82
  83           <ul class="nav navbar-nav navbar-right">
  84             <li><a href="http://builtwithbootstrap.com/" target="_blank">Built With Bootstrap</a></li>
  85             <li><a href="https://wrapbootstrap.com/?ref=bsw" target="_blank">WrapBootstrap</a></li>
  86           </ul>
  87
  88         </div>
  89       </div>
  90     </div>
  91
  92     <div class="container">
  93       <div class="row">
  94         <div class="col-lg-9">
  95
  96             <h1 id="quickstart">Quick Start</h1>
  97             <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>
  98
  99             <h1 id="customization">Customization</h1>
 100             <p>To modify a theme or create your own, follow the steps below in your terminal. You'll need to have <a href="https://help.github.com/articles/set-up-git" target="_blank">Git</a> and <a href="http://nodejs.org/" target="_blank">Node</a> installed.</p>
 101             <ol>
 102               <li><p><code>git clone https://github.com/thomaspark/bootswatch.git</code></p></li>
 103               <li><p><code>npm install</code></p></li>
 104               <li>
 105                 <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>
 106               </li>
 107               <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. To have <code>grunt</code> available in the command line, install <code>grunt-cli</code> as described on the <a href="http://gruntjs.com/getting-started">Grunt Getting Started page</a>.</p></li>
 108             </ol>
 109             <p>Here are additional tips for <a href="http://coding.smashingmagazine.com/2013/03/12/customizing-bootstrap/" target="_blank">customizing Bootstrap</a>.</p>
 110
 111             <h1 id="api">API</h1>
 112             <p>You can use the API to integrate the themes with your platform. Send your request to:</p>
 113             <p><a href="http://api.bootswatch.com/3/">http://api.bootswatch.com/3/</a></p>
 114             <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>cssCdn</code>, <code>less</code>, and <code>lessVariables</code>.</p>
 115             <p>Here's a <a href="http://jsbin.com/oqubil/1/edit" target="_blank">demo</a> with mustache.js templating.</p>
 116
 117             <h1 id="bookmarklet">Bookmarklet</h1>
 118             <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%3EFlatly%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%3EUnited%3C/option%3E%3Coption%3EYeti%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>
 119             <p></p>
 120
 121             <h1 id="glyphsearch">GlyphSearch</h1>
 122             <p>Use <a href="http://glyphsearch.com/" target="_blank">GlyphSearch</a> to find the icons you need from Glyphicons, Font Awesome, and other popular icon font libraries.</p>
 123
 124         </div>
 125       </div>
 126     </div>
 127
 128
 129     <div class="container">
 130       <footer>
 131         <div class="row">
 132           <div class="col-lg-12">
 133
 134             <ul class="list-unstyled">
 135               <li class="pull-right"><a href="#top">Back to top</a></li>
 136               <li><a href="http://news.bootswatch.com" onclick="pageTracker._link(this.href); return false;">Blog</a></li>
 137               <li><a href="http://feeds.feedburner.com/bootswatch">RSS</a></li>
 138               <li><a href="https://twitter.com/thomashpark">Twitter</a></li>
 139               <li><a href="https://github.com/thomaspark/bootswatch/">GitHub</a></li>
 140               <li><a href="../help/#api">API</a></li>
 141               <li><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=F22JEM3Q78JC2">Donate</a></li>
 142             </ul>
 143             <p>Made by <a href="http://thomaspark.me" rel="nofollow">Thomas Park</a>. Contact him at <a href="mailto:hello@thomaspark.me">hello@thomaspark.me</a>.</p>
 144             <p>Code licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" rel="nofollow">Apache License v2.0</a>.</p>
 145             <p>Based on <a href="http://getbootstrap.com" rel="nofollow">Bootstrap</a>. Icons from <a href="http://fortawesome.github.io/Font-Awesome/" rel="nofollow">Font Awesome</a>. Web fonts from <a href="http://www.google.com/webfonts" rel="nofollow">Google</a>. Favicon by <a href="https://twitter.com/geraldhiller" rel="nofollow">Gerald Hiller</a>.</p>
 146
 147           </div>
 148         </div>
 149
 150       </footer>
 151
 152     </div>
 153
 154
 155     <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
 156     <script src="../bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
 157     <script src="../assets/js/bootswatch.js"></script>
 158     <script type="text/javascript">
 159       !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");
 160     </script>
 161   </body>
 162 </html>