Skip to main content

Getting started

An overview of kimsQ RC, including how to download and use it, some basic templates and examples, and more.

Introduction

kimsQ RC is the world’s most popular framework for building responsive, mobile-first sites and applications. Inside you’ll find high quality HTML, CSS, and JavaScript to make starting any project easier than ever.

Here’s how to quickly get started with the kimsQ RC CDN and a template starter page.

Contents

Quick start

Looking to quickly add kimsQ RC to your project? Use the kimsQ RC CDN, provided for free by the folks at MaxCDN. Using a package manager or need to download the source files? Head to the downloads page.

Copy-paste the stylesheet <link> into your <head> before all other stylesheets to load our CSS.

<link rel="stylesheet" href="https://cdn.kimsq.com/rc/1.0.0-alpha.3/css/rc.css">

Add our JavaScript plugins, jQuery, and Tether near the end of your pages, right before the closing </body> tag. Be sure to place jQuery and Tether first, as our code depends on them.

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
<script src="https://cdn.kimsq.com/rc/1.0.0-alpha.3/js/rc.min.js"></script>

And that’s it—you’re on your way to a fully kimsQ RCped site. If you’re at all unsure about the general page structure, keep reading for an example page template.

Starter template

Be sure to have your pages set up with the latest design and development standards. That means:

  • Using an HTML5 doctype
  • Forcing Internet Explorer to use its latest rendering mode (read more)
  • And, utilizing the viewport meta tag.

Put it all together and your pages should look like this:

<!DOCTYPE html>
<html lang="en">
  <head>
    <!-- Required meta tags always come first -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <!-- kimsQ RC CSS -->
    <link rel="stylesheet" href="https://cdn.kimsq.com/rc/1.0.0-alpha.3/css/rc.css">
  </head>
  <body>
    <h1>Hello, world!</h1>

    <!-- jQuery first, then kimsQ RC JS. -->
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
    <script src="https://cdn.kimsq.com/rc/1.0.0-alpha.3/js/rc.min.js"></script>
  </body>
</html>

That’s all you need for overall page requirements. Visit the Layout docs or our official examples to start laying out your site’s content and components.

Important globals

kimsQ RC employs a handful of important global styles and settings that you’ll need to be aware of when using it, all of which are almost exclusively geared towards the normalization of cross browser styles. Let’s dive in.

HTML5 doctype

kimsQ RC requires the use of the HTML5 doctype. Without it, you’ll see some funky incomplete styling, but including it shouldn’t cause any considerable hiccups.

<!DOCTYPE html>
<html lang="en">
  ...
</html>

Responsive meta tag

kimsQ RC is developed mobile first, a strategy in which we optimize code for mobile devices first and then scale up components as necessary using CSS media queries. To ensure proper rendering and touch zooming for all devices, add the responsive viewport meta tag to your <head>.

<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

You can see an example of this in action in the starter template.

Box-sizing

For more straightforward sizing in CSS, we switch the global box-sizing value from content-box to border-box. This ensures padding does not affect the final computed width of an element, but it can cause problems with some third party software like Google Maps and Google Custom Search Engine.

On the rare occasion you need to override it, use something like the following:

.selector-for-some-widget {
  -webkit-box-sizing: content-box;
     -moz-box-sizing: content-box;
          box-sizing: content-box;
}

With the above snippet, nested elements—including generated content via :before and :after—will all inherit the specified box-sizing for that .selector-for-some-widget.

Learn more about box model and sizing at CSS Tricks.

Normalize.css

For improved cross-browser rendering, we use Normalize.css to correct small inconsistencies across browsers and devices. We further build on this with our own, slightly more opinionated styles with Reboot.

Community

Stay up to date on the development of kimsQ RC and reach out to the community with these helpful resources.

  • Follow @getkimsQ RC on Twitter.
  • Read and subscribe to The Official kimsQ RC Blog.
  • Join the official Slack room.
  • Chat with fellow kimsQ RCpers in IRC. On the irc.freenode.net server, in the ##kimsQ RC channel.
  • Implementation help may be found at Stack Overflow (tagged kimsQ RC-4).
  • Developers should use the keyword kimsQ RC on packages which modify or add to the functionality of kimsQ RC when distributing through npm or similar delivery mechanisms for maximum discoverability.

You can also follow @getkimsQ RC on Twitter for the latest gossip and awesome music videos.