UNPKG

3.06 kBMarkdownView Raw
1[![uikit banner](https://cloud.githubusercontent.com/assets/321047/21769911/474d7d9e-d681-11e6-9fe0-d95f8ccfd3a9.jpg)](http://getuikit.com/)
2
3# UIkit
4
5[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/NEt4Pv7)
6
7UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces.
8
9* [Homepage](http://getuikit.com) - Learn more about UIkit
10* [@getuikit](https://twitter.com/getuikit) - Get the latest buzz on Twitter
11* [Discord Chat](https://discord.gg/NEt4Pv7) - Join our developer chat on Discord.
12
13---
14
15<p align="center">
16 <b>UIkit is an Open Source project developed by YOOtheme.</b>
17 <br><br>
18 <a href="https://yootheme.com" align="center">
19 <img width="134" height="30" src="http://yootheme.com/site/images/yootheme-logo.svg">
20 </a>
21</p>
22
23---
24
25## Getting started
26
27You have the following options to get UIkit:
28
29- Download the [latest release](https://github.com/uikit/uikit/releases/latest) with pre-built CSS and JS.
30- Install with [npm](https://npmjs.com) to get all source files as they are available on Github: ```npm install uikit```
31- Install with [yarn](https://yarnpkg.com/) to get all source files as they are available on Github: ```yarn add uikit```
32- Directly load UIkit from [CDNJS](https://cdnjs.com): https://cdnjs.com/libraries/uikit
33- Clone the repo to get all source files including build scripts: `git clone git://github.com/uikit/uikit.git`
34
35## Developers
36
37To always have the latest development version of UIkit, even before a release, you may want to use npm or yarn with the `dev` tag.
38
39- Using npm: ```npm install uikit@dev```
40- Using yarn: ```yarn add uikit@dev```
41- Using [cdn](cdn.jsdelivr.net): https://cdn.jsdelivr.net/npm/uikit@dev
42
43## Contributing
44
45Finding bugs, sending pull requests or improving our docs - any contribution is welcome and highly appreciated. To get started, head over to our [contribution guidelines](CONTRIBUTING.md). Thanks!
46
47## Versioning
48
49UIkit is maintained by using the [Semantic Versioning Specification (SemVer)](http://semver.org).
50
51## Browser Support
52
53![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png)
54--- | --- | --- | --- | --- | --- |
55Latest ✔ | Latest ✔ | Latest ✔ | 11+ ✔ | 9.1+ ✔ | Latest ✔ |
56
57Tested With<br>[![BrowserStack](https://user-images.githubusercontent.com/355427/27389060-9f716c82-569d-11e7-923c-bd5fe7f1c55a.png)](https://www.browserstack.com)
58
59## Copyright and License
60
61Copyright [YOOtheme](https://yootheme.com) GmbH under the [MIT license](LICENSE.md).
62
\No newline at end of file