<commit_before>Colos: a Jekyll theme
=====================

[![Build Status](https://travis-ci.org/ahaasler/colos.svg?branch=gh-pages)](https://travis-ci.org/ahaasler/colos)
[![Dependency Status](https://gemnasium.com/ahaasler/colos.svg)](https://gemnasium.com/ahaasler/colos)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

_Colos_ is a minimal, multilingual theme for [_Jekyll_](http://jekyllrb.com/ "Jekyll &bull; Simple, blog-aware, static sites").

You can find the live demo in http://colos.adrianhaasler.com, proudly hosted on _GitHub_.

Features
--------

- 100% compatible with [_GitHub Pages_](https://pages.github.com/ "GitHub Pages").
- Multilingual support.

### To do

- Material design.
- Color everywhere!

Dependencies
------------

- *github-pages*: Contains Jekyll and its dependencies to work properly on GitHub Pages. Uses the version defined in https://pages.github.com/versions.json, which is the currently deployed.
- *html-proofer*: It's used to validate the generated site. No version is specified in order to use the last version available.

License
-------

This theme is released under the [MIT License](http://opensource.org/licenses/MIT "The MIT License").

See [LICENSE](LICENSE "The MIT License").<commit_msg>Add getting started section in README.md<commit_after>Colos: a Jekyll theme
=====================

[![Build Status](https://travis-ci.org/ahaasler/colos.svg?branch=gh-pages)](https://travis-ci.org/ahaasler/colos)
[![Dependency Status](https://gemnasium.com/ahaasler/colos.svg)](https://gemnasium.com/ahaasler/colos)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

*Colos* is a minimal, multilingual theme for *[Jekyll](http://jekyllrb.com/ "Jekyll &bull; Simple, blog-aware, static sites")*.

You can find the live demo in http://colos.adrianhaasler.com, proudly hosted on *GitHub*.

Features
--------

- 100% compatible with *[GitHub Pages](https://pages.github.com/ "GitHub Pages")*.
- Multilingual support.

### To do

- Material design.
- Color everywhere!

Getting Started
---------------

### Prerequisites

1. Make sure you have *ruby-dev* installed (you may also need *ruby*, *rubygems* and/or *gem* if not automatically installed). `yum install -y ruby-devel`, `apt-get install -y ruby-dev` or the equivalent for your distro/package manager.

2. You will also need *bundler* to handle your gems: `gem install bundler`.

3. Clone or [fork](https://github.com/ahaasler/colos/fork "Fork your own copy of ahaasler/colos to your account") the repo: `git clone https://github.com/ahaasler/jekyll-base.git` (use the URL of your fork).

4. Install all necessary *gems*: `bundle install`.

### Build or serve your site

To build the site use the following command: `./script/build`. This will also validate the generated site, located inside the `_site` folder.

If you want to see how the site looks like use: `./script/serve`. Now go to `http://localhost:4000` in your browser. As long as the command is running you can edit your site and see the changes **live**.

Dependencies
------------

- *github-pages*: Contains Jekyll and its dependencies to work properly on GitHub Pages. Uses the version defined in https://pages.github.com/versions.json, which is the currently deployed.
- *html-proofer*: It's used to validate the generated site. No version is specified in order to use the last version available.

License
-------

This theme is released under the [MIT License](http://opensource.org/licenses/MIT "The MIT License").

See [LICENSE](LICENSE "The MIT License").
{'fraction_non_alphanumeric': 0.15522555337629587, 'fraction_numerical': 0.003922667413841412, 'mean_word_length': 4.1072961373390555, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '546522', 'n_tokens_mistral': 1125, 'n_tokens_neox': 1068, 'n_words': 371}