<commit_before>## Clean blog theme

Clean blog theme is a ported theme to Spress designed by [Start Bootstrap](http://startbootstrap.com/).

[Live demo](http://spress-add-ons.github.io/clean-blog/).

**This theme requires Spress >= 2.2**. If you are using Spress 1.x, go to [1.0.0](https://github.com/spress-add-ons/Clean-blog-theme/releases/tag/v1.0.0) version of the theme.

![Spresso theme preview](/screenshot.png)

### Features

* Fully responsive.
* Distraction free blog text optimized for legibility.
* Contact form powered by [getsimpleform](https://getsimpleform.com/).
* Comments powered by [Disqus](https://disqus.com).

## Installation
You can create a [site based on Clean blog](#creating-a-new-site-based-on-this-theme-creating-site)
or install this one as a theme of a [pre-existing site](#install-as-a-theme-of-pre-existing-site-pre-existing).

**Requirements:**
* Spress >= 2.2.0

### Creating a new site based on this theme

Performs the following command and Spresso theme will be
installed in `mysite` folder:

```bash
$ spress new:site mysite spress-add-ons/clean-blog-theme
```

### Install as a theme of an pre-existing site

Go to your site folder and performs the following command:

```bash
$ spress add:plugin spress-add-ons/clean-blog-theme
```
And add this line to the `config.yml` file of your site:

```yaml
themes:
    name: spress-add-ons/clean-blog-theme
```

### How to update?

You can get the latest version of Clean blog theme with just run the following command:

```bash
$ spress update:plugin
```

## Configuration

### Comments

Comments are powered by [Disqus](disqus.com) and they need a
**disqus shortname**. To get it, you need to create an account at this service.
It's free.

```yaml
comments:
  enabled: true
  disqus_shortname: "your-shortname"
```

### Top menu

The top menu is composed by each of **pages with `title` attribute**. e.g: `./src/content/about.md`:

```yaml
title: "About me"
```

### Contact form

The contact form is a AJAX form configured in `config.yml`:

```yaml
forms:
    contact:
        getsimpleform_api_token:
```

You need a API key from [getsimpleform](https://getsimpleform.com/) service. It's free.

### Writing a post

To create a new post, runs `new:post` command from Spress:

```bash
$ spress new:post
```

Each post could has a header and thumbnail image. You can configure your image and some data about it.

```yaml
header_img:
  url: "assets/img/post-bg-07.jpg"
  author: "<NAME>"
  author_url: "https://flic.kr/p/mjhDwB"
```


## License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0).<commit_msg>Added doc for thumbnail images<commit_after>## Clean blog theme

Clean blog theme is a ported theme to Spress designed by [Start Bootstrap](http://startbootstrap.com/).

[Live demo](http://spress-add-ons.github.io/clean-blog/).

![Spresso theme preview](/screenshot.png)

### Features

* Fully responsive.
* Distraction free blog text optimized for legibility.
* Support for tags and categories in posts.
* Contact form powered by [getsimpleform](https://getsimpleform.com/).
* Comments powered by [Disqus](https://disqus.com).
* Code highlighted thanks to [highlight.js](https://highlightjs.org/).

## Installation
You can create a [site based on Clean blog](#creating-a-new-site-based-on-this-theme-creating-site)
or install this one as a theme of a [pre-existing site](#install-as-a-theme-of-pre-existing-site-pre-existing).

**Requirements:**
* Spress >= 2.2.0

### Creating a new site based on this theme

Performs the following command and clean-blog theme will be
installed in `mysite` folder:

```bash
$ spress new:site mysite spress-add-ons/clean-blog-theme
```

### Install as a theme of an pre-existing site

Go to your site folder and performs the following command:

```bash
$ spress add:plugin spress-add-ons/clean-blog-theme
```

And add this line to the `config.yml` file of your site:

```yaml
themes:
    name: spress-add-ons/clean-blog-theme
```

### How to update?

You can get the latest version of Clean blog theme with just run the following command:

```bash
$ spress update:plugin
```

## Configuration

### Comments

Comments are powered by [Disqus](disqus.com) and they need a
**disqus shortname**. To get it, you need to create an account at this service.
It's free.

```yaml
comments:
  enabled: true
  disqus_shortname: "your-shortname"
```

### Top menu

The top menu is composed by each of **pages with `title` attribute**.
e.g: `./src/content/about.md`:

```yaml
title: "About me"
```

### Contact form

The contact form is a AJAX form configured in `config.yml`:

```yaml
forms:
    contact:
        getsimpleform_api_token:
```

You need a API key from [getsimpleform](https://getsimpleform.com/) service. It's free.

### Writing a post

To create a new post, runs `new:post` command from Spress:

```bash
$ spress new:post
```

Each post could has a header and thumbnail image. You can configure your image and some data about it.

```yaml
header_img:
  url: "assets/img/post-bg-07.jpg"
  author: "<NAME>"
  author_url: "https://flic.kr/p/mjhDwB"
```

#### Thumbnail images

The `index.html` page can display a thumbnail image for each post. This kind
of images must be located at `./src/content/assets/img` folder and the image
may has the dimentions `100x100 px`.

At the `thumb_img` key of each post you set the name of the image file: 

```yaml
thumb_img: spress.png
```

## License

[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0).
{'fraction_non_alphanumeric': 0.13284671532846715, 'fraction_numerical': 0.006021897810218978, 'mean_word_length': 4.070305272895467, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 8, 'https://': 10, 'lorem ipsum': 0, 'www.': 2, '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': '583456', 'n_tokens_mistral': 1859, 'n_tokens_neox': 1761, 'n_words': 633}