Introduction

Get started with Docs UI Kit, Responsive Website Template for building responsive documentations.

Docs UI Kit is a Static HTML Template

For the time being, we do NOT offer any tutorials or any other materials on how to integrate Docs UI Kit with any CMS, Web Application framework (including Angular JS, Ruby on Rails and others) or any other similar technology. However, since Docs UI Kit is a static HTML/CSS and JS template, then it should be compatible with any front-end & backend technology.

Quick start

There are two ways to run any Htmlstream's (further - HS) Template on your project:

  1. Gulp - this is the most recommended way of using HS templates.

  2. Localhost - using a localhost server is extremely vital in any HTML template, as it boosts the page load. For this reason, any template or website might work slowly or may not even work at all without localhost. Like in the case of the Master sliders and the Revolution Sliders. Opening Docs UI Kit in localhost server should not give you any problems.

    In computer networking, localhost is a hostname that means this computer. It is used to access the network services that are running on the host via its loopback network interface. Using the loopback interface bypasses any local network interface hardware.

    The local loopback mechanism is useful for testing software during development, independently of any networking configurations. For example, if a computer has been configured to provide a website, directing a locally running web browser to http://localhost may display its home page.

    Just so you know, Ajax also does not work without a localhost server. The whole point of Ajax request is to fetch data from one of these computers, which has to be listening in for specific network packages.

CSS

Copy-paste Docs UI Kit stylesheets <link> into your <head> after all other stylesheets to load our CSS.

                
                  <!-- CSS Template -->
                  <link rel="stylesheet" href="assets/css/theme.css">

JS

Many of Bootstrap's (since Docs UI Kit runs on Bootstrap) components require the use of JavaScript to function. Specifically, they require jQuery, Popper.js, Bootstrap JavaScript and our JavaScript files. Place the following <script>s near the end of your pages, right before the closing </body> tag, to enable them. jQuery must come first, then Popper.js, Bootstrap's JavaScript and then plugins.

Bootstrap and Docs UI Kit use jQuery's slim build, but the full version is also supported.

                
                  <!-- JS Global Compulsory -->
                  <script src="assets/vendor/jquery/dist/jquery.min.js"></script>
                  <script src="assets/vendor/jquery-migrate/dist/jquery-migrate.min.js"></script>
                  <script src="assets/vendor/popper.js/dist/umd/popper.min.js"></script>
                  <script src="assets/vendor/bootstrap/dist/js/bootstrap.min.js"></script>

                  <!-- JS  -->
                  <script src="assets/js/main.js"></script>

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

                
                  <!doctype html>
                  <html lang="en">
                  <head>
                    <!-- Title -->
                    <title>Hello, world!</title>

                    <!-- Favicon -->
                    <link rel="shortcut icon" href="favicon.png">

                    <!-- Required meta tags -->
                    <meta charset="utf-8">
                    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

                    <!-- CSS Implementing Plugins -->
                    <link rel="stylesheet" href="assets/vendor/font-awesome/css/fontawesome-all.min.css">

                    <!-- CSS Template -->
                    <link rel="stylesheet" href="assets/css/theme.css">
                  </head>

                  <body>
                    <h1>Hello, world!</h1>

                    <!-- JS Global Compulsory -->
                    <script src="assets/vendor/jquery/dist/jquery.min.js"></script>
                    <script src="assets/vendor/jquery-migrate/dist/jquery-migrate.min.js"></script>
                    <script src="assets/vendor/popper.js/dist/umd/popper.min.js"></script>
                    <script src="assets/vendor/bootstrap/dist/js/bootstrap.min.js"></script>

                    <!-- JS -->
                    <script src="assets/js/main.js"></script>
                  </body>
                  </html>

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

Important globals

Docs UI Kit 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

Docs UI Kit 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

Docs UI Kit 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.