https://github.com/LuisGC/blog
Raw File
Tip revision: 3f1e6dcb65ed38478393150db09320c5e7c5c1e2 authored by CircleCI on 18 February 2018, 16:35 UTC
Generated site on Sun Feb 18 16:35:41 UTC 2018 [ci skip]
Tip revision: 3f1e6dc
README.md
# Luiyología

This blog uses [**JBake**](http://jbake.org/), enriched by the great [**Future Imperfect Template**](https://github.com/manikmagar/jbake-future-imperfect-template) by [**@manikmagar**](https://github.com/manikmagar)

[![Build Status](https://circleci.com/gh/LuisGC/blog.svg?style=shield&circle-token=84b0c3abe4224e336ee9d92c7e04204e9a2b2767)](https://circleci.com/gh/LuisGC/blog)

## About JBake

[**JBake**](http://jbake.org/) is a Java based open source static site/blog generator for developers. Check the code on [Github](https://github.com/jbake-org/jbake)

## About JBake Future Imperfect Template

**Future Imperfect** is based on [HTML5 UP's theme](http://html5up.net/future-imperfect). Julio Pescador [ported](https://github.com/jpescador/hugo-future-imperfect) it for SSG websites. It is adapted for [JBake](http://jbake.org/) by [**@manikmagar**](https://github.com/manikmagar)

## Want one? Follow this instructions

First, make sure you install JBake as per instructions [here](http://jbake.org/download.html).

Once you have JBake, assuming you are creating a site called '**awesome-jbake**', in the terminal/command window run below commands -

```shell
>> mkdir awesome-jbake

>> git clone https://github.com/manikmagar/jbake-future-imperfect-template.git awesome-jbake

>> cd awesome-jbake && ls -ltr

```

You should see this repo files in there. Check [JBake 2.5.1 Documentation](http://jbake.org/docs/2.5.1/#project_structure) to understand this structure.

To see in action, while in awesome-jbake folder, run `jbake -b -s`. In few seconds your site should be live on http://localhost:8820/, you can visit it in browser.

## Configuring jbake.properties

Everything in the template is driven by configuration parameters in jbake.properties file. Minimally required property set is already included, So keep all the properties in file and modify the values as needed.

JBake does support more than these properties and you can refer [JBake Documentation](http://jbake.org/docs/).

Some tempalte features are described below.

### Disqus Comments

Template does support adding [Disqus](https://disqus.com/) comments to Posts. To enable it, just add your disqus shortname in jbake.properties -

`site.disqus.shortname={yourdisqus}`

### Google Analytics

Template allows you to capture Page Views. To enable it, just add your GA Tracking id in jbake.properties -

`site.google.trackingid={ga.trackingid}`

### Estimated Reading Time

You can enable Estimated Reading time on your posts, by setting `site.includeReadTiem=true` in jbake.properties. This reading time is calculated using [this](https://github.com/michael-lynch/reading-time) reading time javascript library.

### Site Main Menu

Site's top main menu can be controlled from jbake.properties -

```properties
site.menus.main = home, archive, about, rss
#To add menus, for every menuitem in site.menus.main, add three properties in below pattern
#site.menus.{menuitem}.home.label=Home
#site.menus.{menuitem}.home.url=/
#site.menus.{menuitem}.home.icon=fa fa-home

site.menus.main.home.label=Home
site.menus.main.home.url=/
site.menus.main.home.icon=fa fa-home

```

You MUST define label, url and icon properties for each menu item in `site.menus.main`.

### Social Links

You can control your social links by adding your social handlers for sidebar.social.* propeties.

## Adding 404 page not found for GitHub

If you are hosting your static site on Github, then Github allows to set 404 error page. Content folder has a file called 404.html which is of type 'page' (i.e. it will be rendered by page template). You can modify this file content if neeeded but default included one also looks good :). This file **must be** at the root of content folder so that it gets rendered to root directory of your github pages. Rest will be take care by Github to show this file when user tries to non-existent url.

## Post Featured Images

In the [post metadata header](http://jbake.org/docs/2.5.1/#metadata_header), you can define below two properties to have a featured image for the post -

```properties
featuredimage=img/{path to image}
featuredalt=alternate text for image
```

## License

This blog is released under the MIT license, as both **JBake** and the **Future Imperfect Template**.

Please read the [license](LICENSE.md) for more information.
back to top