index.html 10.8 KB
Newer Older
Thomas Park's avatar
Thomas Park committed
1
2
3
4
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
XhmikosR's avatar
XhmikosR committed
5
6
    <title>Bootswatch: Help</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">
7
    <link rel="stylesheet" href="../flatly/bootstrap.css" media="screen">
Thomas Park's avatar
Thomas Park committed
8
    <link rel="stylesheet" href="../assets/css/bootswatch.min.css">
9
10
    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
    <!--[if lt IE 9]>
11
12
      <script src="../bower_components/html5shiv/dist/html5shiv.js"></script>
      <script src="../bower_components/respond/dest/respond.min.js"></script>
13
    <![endif]-->
Thomas Park's avatar
Thomas Park committed
14
15
    <style>

Thomas Park's avatar
Thomas Park committed
16
17
18
19
      h1 {
        margin-top: 2em;
      }

Thomas Park's avatar
Thomas Park committed
20
      code {
Thomas Park's avatar
Thomas Park committed
21
22
        background-color: #eee;
        color: inherit;
Thomas Park's avatar
Thomas Park committed
23
24
25
      }

    </style>
XhmikosR's avatar
XhmikosR committed
26
    <script>
Thomas Park's avatar
Thomas Park committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

     var _gaq = _gaq || [];
      _gaq.push(['_setAccount', 'UA-23019901-1']);
      _gaq.push(['_setDomainName', "bootswatch.com"]);
        _gaq.push(['_setAllowLinker', true]);
      _gaq.push(['_trackPageview']);

     (function() {
       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
     })();

    </script>
  </head>
  <body>

Thomas Park's avatar
Thomas Park committed
44
    <div class="navbar navbar-default navbar-fixed-top">
Thomas Park's avatar
Thomas Park committed
45
      <div class="container">
Thomas Park's avatar
Thomas Park committed
46
        <div class="navbar-header">
Jenil Gogari's avatar
Jenil Gogari committed
47
          <a href="../" class="navbar-brand">Bootswatch</a>
Thomas Park's avatar
Thomas Park committed
48
49
50
51
52
53
54
          <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#navbar-main">
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <div class="navbar-collapse collapse" id="navbar-main">
Thomas Park's avatar
Thomas Park committed
55
56
57
58
          <ul class="nav navbar-nav">
            <li class="dropdown">
              <a class="dropdown-toggle" data-toggle="dropdown" href="#" id="themes">Themes <span class="caret"></span></a>
              <ul class="dropdown-menu" aria-labelledby="themes">
Thomas Park's avatar
Thomas Park committed
59
                <li><a href="../default/">Default</a></li>
Thomas Park's avatar
Thomas Park committed
60
                <li class="divider"></li>
Thomas Park's avatar
Thomas Park committed
61
62
63
64
                <li><a href="../amelia/">Amelia</a></li>
                <li><a href="../cerulean/">Cerulean</a></li>
                <li><a href="../cosmo/">Cosmo</a></li>
                <li><a href="../cyborg/">Cyborg</a></li>
Thomas Park's avatar
Thomas Park committed
65
                <li><a href="../darkly/">Darkly</a></li>
Thomas Park's avatar
Thomas Park committed
66
67
68
69
70
71
72
73
74
75
                <li><a href="../flatly/">Flatly</a></li>
                <li><a href="../journal/">Journal</a></li>
                <li><a href="../lumen/">Lumen</a></li>
                <li><a href="../readable/">Readable</a></li>
                <li><a href="../simplex/">Simplex</a></li>
                <li><a href="../slate/">Slate</a></li>
                <li><a href="../spacelab/">Spacelab</a></li>
                <li><a href="../superhero/">Superhero</a></li>
                <li><a href="../united/">United</a></li>
                <li><a href="../yeti/">Yeti</a></li>
Thomas Park's avatar
Thomas Park committed
76
77
78
              </ul>
            </li>
            <li class="active">
Jenil Gogari's avatar
Jenil Gogari committed
79
              <a href="../help/">Help</a>
Thomas Park's avatar
Thomas Park committed
80
81
82
83
84
85
            </li>
            <li>
              <a href="http://news.bootswatch.com">Blog</a>
            </li>
          </ul>

Thomas Park's avatar
Thomas Park committed
86
          <ul class="nav navbar-nav navbar-right">
Thomas Park's avatar
Thomas Park committed
87
88
89
90
91
92
93
94
95
96
97
            <li><a href="http://builtwithbootstrap.com/" target="_blank">Built With Bootstrap</a></li>
            <li><a href="https://wrapbootstrap.com/?ref=bsw" target="_blank">WrapBootstrap</a></li>
          </ul>

        </div>
      </div>
    </div>

    <div class="container">
      <div class="row">
        <div class="col-lg-9">
Thomas Park's avatar
Thomas Park committed
98
            <h1 id="quickstart">Quick Start</h1>
Thomas Park's avatar
Thomas Park committed
99
100
            <p>Using the themes 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>
            <p>The themes are also available via CDN at <a href="http://www.bootstrapcdn.com/#bootswatch_tab">BootstrapCDN</a>.</p>
Thomas Park's avatar
Thomas Park committed
101
102
          </div>
        </div>
Thomas Park's avatar
Thomas Park committed
103

Thomas Park's avatar
Thomas Park committed
104
105
        <div class="row">
          <div class="col-lg-9">
106
            <h1 id="customization">Customization</h1>
107
            <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>
Thomas Park's avatar
Thomas Park committed
108
            <ol>
109
              <li><p><code>git clone https://github.com/thomaspark/bootswatch.git</code></p></li>
Thomas Park's avatar
Thomas Park committed
110
111
112
113
              <li><p><code>npm install</code></p></li>
              <li>
                <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>
              </li>
114
              <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>
Thomas Park's avatar
Thomas Park committed
115
            </ol>
Thomas Park's avatar
Thomas Park committed
116
            <p>Here are additional tips for <a href="http://coding.smashingmagazine.com/2013/03/12/customizing-bootstrap/" target="_blank">customizing Bootstrap</a>.</p>
Thomas Park's avatar
Thomas Park committed
117
118
          </div>
        </div>
Thomas Park's avatar
Thomas Park committed
119

Thomas Park's avatar
Thomas Park committed
120
121
        <div class="row">
          <div class="col-lg-12">
Thomas Park's avatar
Thomas Park committed
122
123
124
            <h1 id="api">API</h1>
            <p>You can use the API to integrate the themes with your platform. Send your request to:</p>
            <p><a href="http://api.bootswatch.com/3/">http://api.bootswatch.com/3/</a></p>
Thomas Park's avatar
Thomas Park committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
            <p>This returns an object with a <code>version</code> and a <code>themes</code> property. <code>themes</code> is an array with the following properties:</p>
            <ul>
              <li><code>name</code></li>
              <li><code>description</code></li>
              <li><code>preview</code></li>
              <li><code>thumbnail</code></li>
              <li><code>css</code></li>
              <li><code>cssMin</code></li>
              <li><code>cssCdn</code></li>
              <li><code>less</code></li>
              <li><code>lessVariables</code></li>
            </ul>
            <p>Here's a demo of the API in action.</p>
            <a class="jsbin-embed" href="http://jsbin.com/rabij/1/embed?html,js,output&height=500px">Bootswatch API Demo</a><script src="http://static.jsbin.com/js/embed.js"></script>
          </div>
        </div>

Thomas Park's avatar
Thomas Park committed
142

Thomas Park's avatar
Thomas Park committed
143
144
        <div class="row">
          <div class="col-lg-9">
145
            <h1 id="bookmarklet">Bookmarklet</h1>
146
            <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%3ELumen%3C/option%3E3Coption%3EReadable%3C/option%3E%3Coption%3ESimplex%3C/option%3E%3Coption%3ESlate%3C/option%3E%3Coption%3ESpacelab%3C/option%3E%3Coption%3ESuperhero%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>
147
148
149
150
151
            <p></p>

            <h1 id="glyphsearch">GlyphSearch</h1>
            <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>

Thomas Park's avatar
Thomas Park committed
152
153
154
155
156
157
158
159
160
        </div>
      </div>
    </div>


    <div class="container">
      <footer>
        <div class="row">
          <div class="col-lg-12">
161

Thomas Park's avatar
Thomas Park committed
162
163
164
165
166
167
            <ul class="list-unstyled">
              <li class="pull-right"><a href="#top">Back to top</a></li>
              <li><a href="http://news.bootswatch.com" onclick="pageTracker._link(this.href); return false;">Blog</a></li>
              <li><a href="http://feeds.feedburner.com/bootswatch">RSS</a></li>
              <li><a href="https://twitter.com/thomashpark">Twitter</a></li>
              <li><a href="https://github.com/thomaspark/bootswatch/">GitHub</a></li>
168
              <li><a href="../help/#api">API</a></li>
Thomas Park's avatar
Thomas Park committed
169
170
              <li><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=F22JEM3Q78JC2">Donate</a></li>
            </ul>
Thomas Park's avatar
Thomas Park committed
171
            <p>Made by <a href="http://thomaspark.me" rel="nofollow">Thomas Park</a>. Contact him at <a href="mailto:thomas@bootswatch.com">thomas@bootswatch.com</a>.</p>
Thomas Park's avatar
Thomas Park committed
172
            <p>Code released under the <a href="https://github.com/thomaspark/bootswatch/blob/gh-pages/LICENSE">MIT License</a>.</p>
Thomas Park's avatar
Thomas Park committed
173
            <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>.</p>
Thomas Park's avatar
Thomas Park committed
174
175
176

          </div>
        </div>
177

Thomas Park's avatar
Thomas Park committed
178
      </footer>
179

Thomas Park's avatar
Thomas Park committed
180
181
182
    </div>


183
    <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
Thomas Park's avatar
Thomas Park committed
184
185
    <script src="../bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
    <script src="../assets/js/bootswatch.js"></script>
XhmikosR's avatar
XhmikosR committed
186
    <script>
Thomas Park's avatar
Thomas Park committed
187
188
189
      !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");
    </script>
  </body>
190
</html>