From f92fd09a12df46123a3c190e7bf1add8901c0de6 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill <pmarsceill@users.noreply.github.com> Date: Fri, 26 Oct 2018 11:27:56 -0400 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c4cb9c9d..f8c49fc7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ -# Just the Docs [](https://badge.fury.io/rb/just-the-docs) [](https://travis-ci.com/pmarsceill/just-the-docs) +<p align="right"> + <a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://travis-ci.com/pmarsceill/just-the-docs"><img src="https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master" alt="Build status"></a> +</p> +<br><br> +<p align="center"> + <h1 align="center">Just the Docs</h1> + <p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub pages with few dependencies.</p> + <br><br><br> +</p> -A nice looking, high customizable, responsive Jekyll theme for documentation with built-in search. Easily hosted on GitHub pages.  - ## Installation Add this line to your Jekyll site's Gemfile: @@ -42,6 +48,13 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsc - Await code review - Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/). +### Design and development principles of this theme: + +1. As few dependencies as possible +2. No build script needed +3. First class mobile experience +4. Make the content shine + ## Development To set up your environment to develop this theme, run `bundle install`. -- GitLab