topic Getting started with UIkit

  1. 8.x-3.x uikit.api.php getting_started
  2. 8.x-2.x uikit.api.php getting_started
  3. 7.x-3.x uikit.api.php getting_started
  4. 7.x-2.x uikit.api.php getting_started

Get familiar with the basic setup and structure of UIkit 8.

UIkit 8 does not come with the required UIkit framework files because, in general, 3rd party libraries and content are forbidden from being committed to a reporsitory for projects hosted on We instead use to retrieve the UIkit library.

This also makes the footprint of our repository smaller. Simply follow the instructions below to get started with using UIkit 8.

Download UIkit

First of all you need to download UIkit 8. There are three ways to do this:

  • direct download from project page
  • downloading via Drush
  • cloning repository from

Please read the Installing themes article before installing UIkit 8. We only provide the download methods below, not how to install themes.

NOTE: Recommended for theme developers only. Since UIkit 8 is still in development, none of the following ways to download UIkit 8 are recommended for use on production sites. UIkit 8 is still considered unstable.

via (recommended for site administrators)

You can either visit or use one of the links below to download the project directly from

UIkit 8.x-3.0-rc3.tar.gz UIkit

via Drush (recommended for site administrators comfortable with Drush)

Drush is a command line and shell scripting interface for Drupal. Use the following command to download UIkit 8 with Drush.

drush dl uikit 

Information on installing and using Drush can be found here.

via (recomended for theme developers only)

Use the following Git command to download the development release from the 8.x-2.x branch. This will ensure you get the latest commited development release.

git clone --branch 8.x-2.x 

The development branch is where all new development resides and not recommended for use on production sites. Work still needs done before a release candidate can be released. We ask you use the issue queue to report bugs, support or feature requests.


There are no requirements to use UIkit 8.

Once you have finished implementing UIkit into your Drupal site, take a look look at the Creating a UIkit sub-theme to create a UIkit sub-theme.

Add new comment

Filtered HTML

  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd>
  • Lines and paragraphs break automatically.

Plain text

  • No HTML tags allowed.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Lines and paragraphs break automatically.

Log in