Flat-UI/docs/getting-started.html at master · CssFormWork/Flat-UI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Getting started &middot; Flat UI Free</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <!-- Loading Bootstrap -->
    <link href="../dist/css/vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">

    <!-- Loading Flat UI -->
    <link href="../dist/css/flat-ui.css" rel="stylesheet">
    <link href="assets/css/docs.css" rel="stylesheet">

    <link rel="shortcut icon" href="../img/favicon.ico">

    <!-- HTML5 shim, for IE6-8 support of HTML5 elements. All other JS at the end of file. -->
    <!--[if lt IE 9]>
      <script src="../dist/js/vendor/html5shiv.js"></script>
      <script src="../dist/js/vendor/respond.min.js"></script>
    <![endif]-->
  </head>
  <body>
    <h1 class="demo-headline">Getting started</h1>
    <div class="container">
      <div class="demo-row">
        <div class="demo-title">
          <h3>What is Flat UI?</h3>
        </div>

        <div class="demo-content demo-content-article">
          <p>
            <a href="http://designmodo.com/flat" target="_blank">Flat UI</a>
            is a beautiful theme for <a href="http://getbootstrap.com" target="_blank">Bootstrap</a>.
            We have redesigned many of its components to look flat in every pixel.
          </p>
          <p>
            For the most part, it is very simple to use, however, to be able to make some form elements and others look exactly how we want, we ended up using some JS plugins, which means it takes a little bit more effort to integrate them into your project.
          </p>
        </div>
      </div><!-- /.demo-row -->

      <div class="demo-row">
        <div class="demo-title">
          <h3>How to Use It?</h3>
        </div>

        <div class="demo-content demo-content-article">
          <p>
            Since Flat UI is built on top of Bootstrap as a theme, you can use it in your <a href="http://getbootstrap.com/" target="_blank">Bootstrap 3</a> project.
            We did not modify any line of Bootstrap, so you will be safe using Flat UI in your ongoing project
            (unless you hacked it yourself!) :)
          </p>
          <p>
            We provide you with the CSS and the <a href="http://lesscss.org/" target="_blank">Less</a> sources.
          </p>
          <ol>
            <li>
              Using CSS is as easy as dropping <code>flat-ui.css</code> into your project folder and
              including it in your template/html page:
              <code>&lt;link href="dist/css/flat-ui.css" rel="stylesheet"&gt;</code>
            </li>
            <li>
              Use Less if you want to modify/extend Flat UI in your project. It is built just like Bootstrap, so
              you won't find a big difference.
            </li>
          </ol>
          <p>
            The easiest way to start is to use our start-up template (from <code>/dist</code> folder) where all the files are already included
            and ready to use (The JS plugins are included, but not initialized. You will have to initialize them as needed).
          </p>
        </div>
      </div><!-- /.demo-row -->

      <div class="demo-row">
        <div class="demo-title">
          <h3>File Structure</h3>
        </div>

        <div class="demo-content demo-content-article">
          <p>
            Flat UI Free have the following structure:
          </p>
<pre class="prettyprint">
flat-ui/
├── dist/
|   ├── css/
|   |   ├── vendors/
│   |   ├── flat-ui.css
│   |   └── flat-ui.min.css
|   ├── js/
|   |   ├── vendors/
│   |   ├── flat-ui.js
│   |   └── flat-ui.min.js
|   ├── fonts/
|   |   ├── lato/
|   |   └── glyphicons/
|   |        ├── flat-ui-icons-regular.eot
|   |        ├── flat-ui-icons-regular.svg
|   |        ├── flat-ui-icons-regular.ttf
|   |        ├── flat-ui-icons-regular.woff
|   |        └── selection.json
|   ├── img/
|   └── index.html
├── docs/
|   ├── examples/
|   ├── components.html
|   ├── getting-started.html
|   └── template.html
├── fonts/
├── img/
├── js/
└── less/
    ├── mixins/
    ├── modules/
    ├── flat-ui.less
    ├── mixins.less
    └── variables.less
</pre>
          <p>
            Let's go through this list:
          </p>

          <p>
            <strong>dist/</strong> &mdash; the compiled Flat UI boilerplate template. If you like everything and you don't want
            to change the look of our components, it is better to use version. This is the easiest
            way to start using Flat UI.
          </p>

          <p>
            <strong></strong> &mdash; component examples and documentation.
          </p>

          <p>
            <strong>fonts/</strong> &mdash; local version of Lato and icon font. When integrating this into your project, make sure you
            copy all the font files correctly. You might want to change/add some glyphs. If so, open
            <a href="http://icomoon.io/app">IcoMoon</a> and import <code>selection.json</code>(at <code>fonts/glyphicons/</code>)
            there to make all glyphs editable.
          </p>

          <p>
            <img src="assets/img/getting-started/icomoon_import.jpg" alt="" />
          </p>

          <p>
            <strong>js/</strong> &mdash; we have tried hard to make all our components look truly "flat." In order to do
            so we have used some JS plugins. Most of them are well known, while some of them are not. The most JS-ified
            components are the form components (checkboxes, radios, switches, selects…), since it is not currently possible
            to style them identically in all browsers. Look at <code>docs/assets/js/application.js</code> for integration
            examples.
          </p>

          <p>
            <strong>less/</strong> &mdash; is where all our stylesheets are located (not preprocessed).
          </p>

          <ul>
            <li>
              <code>modules/</code> is where the components themselves are.
            </li>
            <li>
              <code>mixins/</code> useful utilities.
            </li>
            <li>
              <code>flat-ui.less</code> links everything into one single bundle.
            </li>
            <li>
              <code>mixins.less</code> helps automate things.
            </li>
            <li>
              <code>variables.less</code> is where all the default variables are.
            </li>
          </ul>

        </div>
      </div><!-- /.demo-row -->

      <div class="demo-row">
        <div class="demo-title">
          <h3>Dependencies</h3>
        </div>

        <div class="demo-content demo-content-article">
          <p>
            External dependencies are managed quickly and easily with <a href="http://bower.io">Bower</a>. Simply:
          </p>
          <ol>
            <li>
              Add a dependency to <code>bower.json</code>.
            </li>
            <li>
              Run <code>bower install</code>.
            </li>
            <li>
              Add references within your HTML, and you are all set.
            </li>
          </ol>
          <p>
            <em>Note:</em> If required, run <code>npm install -g bower</code> first to install bower.
          </p>
          <p>
            Development is quick and easy thanks to <a href="http://gruntjs.com/">Grunt</a>. Simply:
          </p>
          <ul>
            <li>
              Run <code>grunt</code> to build the project with your updates included, or
            </li>
            <li>
              Run <code>grunt server</code> to build the project, watch for changes, and provide a local server with source maps and live reload as you hack away.
            </li>
          </ul>
          <p>
            <em>Note:</em> If required, run <code>npm install</code> first to install grunt with grunt packages.
          </p>
        </div>
      </div><!-- /.demo-row -->

    </div><!-- /.container -->
  </body>
</html>