Buy Now

Getting Started

In this section you'll find basic information about Dox and how to install it and use it properly. If you're first time user then you should read this section first.

What is Dox?

Dox is Jekyll theme created for project documentations. You can use it with GitHub and GitLab Pages as well as a standalone project.

What is Jekyll?

Jekyll is a simple, blog-aware, static site generator. It takes a template directory containing raw text files in various formats, runs it through a converter (like Markdown) and Liquid renderer, and spits out a complete, ready-to-publish static website suitable for serving with your favourite web server.

Full Jekyll documentation You can find full Jekyll documentation here.

Install Jekyll


Installing Jekyll should be straight-forward if all requirements are met. Before you start, make sure your system has the following:

  • GNU/Linux, Unix, or macOS
  • Ruby version 2.0 or above, including all development headers
  • RubyGems
  • GCC and Make (in case your system doesn’t have them installed, which you can check by running gcc -v and make -v in your system’s command line interface)

Install with RubyGems

The best way to install Jekyll is via RubyGems. At the terminal prompt, simply run the following command to install Jekyll:

gem install jekyll

All of Jekyll’s gem dependencies are automatically installed by the above command, so you won’t have to worry about them at all.

Full Jekyll installation guide You can find full Jekyll installation guide here.

Install Dox


Download your Dox theme from ThemeForest (you should get and unzip it.

Start development server

Jekyll comes with a built-in development server that will allow you to preview what the generated site will look like in your browser locally.

You can run this commands inside theme folder:

jekyll serve
# A development server will run at http://localhost:4000/
# Auto-regeneration: enabled. Use `--no-watch` to disable.

jekyll serve --no-watch
# Same as `jekyll serve` but will not watch for changes.

jekyll serve --detach
# Same as `jekyll serve` but will detach from the current terminal.
# If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
# If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.

Directory structure

This is Dox basic directory structure which looks like this:

File name Description
.vscode/ Visual Studio Code editor related files.
_documentation/ All documentation files should be located in this folder.
designs/ Design source files (.psd etc.).
dox-theme/ Dox theme source files.
.eslintignore ESlint related file which specifies intentionally untracked files to ignore.
.eslintrc ESlint configuration file.
.gitignore Git related file which specifies intentionally untracked files to ignore.
.gitlab-ci.yml File used by GitLab Runner to manage your project's jobs.
.htaccess Configuration file for use on web servers running the Apache Web Server software.
.stylelintrc Stylelint configuration file. Error 404 layout markdown template.
_config.yml Stores Jekyll configuration data. Default layout markdown template. Documentation layout markdown template.
favicon.ico Favicon icon. Homepage layout markdown template.


We use Feather Icons icon pack in our theme. List of all icons you can use, in some places such as configuration file, features grid, site-wide buttons etc., is available here.

Use names next to icons listed on, for example

Change Log

All notable changes to this project will be documented here. This project adheres to Semantic Versioning.

[v1.0.0] - 2017-12-08

Initial release.


List of vendor assets we used to create this theme: