Skip to content

Commit

Permalink
First documentation approach
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed Jan 6, 2016
1 parent 27d8542 commit fa75f80
Showing 1 changed file with 59 additions and 6 deletions.
65 changes: 59 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Bloggy for Ghost

<p align="center">
<br>
<img src="http://i.imgur.com/bQ9E4z9.png" alt="bloggy">
<br>
</p>

![Last version](https://img.shields.io/github/tag/Kikobeats/bloggy.svg?style=flat-square)
![Ghost version](https://img.shields.io/badge/Ghost-0.7.x-brightgreen.svg?style=flat-square)
![Node version](https://img.shields.io/node/v/bloggy.svg?style=flat-square)
Expand All @@ -9,17 +15,64 @@
## Introduction

**Bloggy** is a fork of [Ghost Blog](https://github.com/TryGhost/Blog) that's make easy have a A Corporative/Marketing blog.
**Bloggy** is a fork of [Ghost Blog](https://github.com/TryGhost/Blog) theme with the unique purpose to make easy and adaptable Ghost theme for brand/corporative/marketing purpose.

## Features

- Possibility to select between a layout of one or two columns.
- Easy to change the look and feel of the theme. Just change the value of the variables!.
- Support a set of widgets in the sidebar.
- i18n support. Currently `en`/`es` supported.
- Google Analytics integration.
- Newsletter integration powered by Mailchimp.
- Featured and Static post views.
- Sidebar based in widgets like popular posts, featured post, social, banner,...
- Easy to hack. No limits!

## First Steps

### Installation

Please ensure that `git` and `curl` is installed on your machine.

Enter the theme folder (`content/themes`) of your Ghost installation and paste the following command:

```bash
$ git clone git@github.com:Kikobeats/bloggy.git
```

### Setup

### DOM Selector

It's necessary that you stablish the DOM library and the version to use with the theme. For do it, go to `Admin Panel``Code Injection``Blog Footer` and should be similar to:

```html
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
```

### i18n

**Supported languages:** `en_US`/`en_ES`

By default, the main JS file of the theme is not linked because it's depend of what language do you want to use.

For do it, the process is similar to the DOM Selector: go to `Admin Panel``Code Injection``Blog Footer`.

Now, the code to paste depend of the language that you want to use in your blog. The template of the code is:

```html
<script type="text/javascript" src="/assets/js/bloggy.#{lang}.js"></script>
```

Replacing the `#{lang}` for the supported language that you want to use.

For example, if you want to use the `en_EN` version, just add:

```html
<script type="text/javascript" src="/assets/js/bloggy.en_EN.js"></script>
```

## Installation
## Related

![](http://www.netanimations.net/under-construction-flashing-barracade-animation.gif)
* [Uno Zen](https://github.com/Kikobeats/uno-zen#uno-zen-for-ghost) – Minimalist and Elegant theme for Ghost.

## License

Expand Down

0 comments on commit fa75f80

Please sign in to comment.