Static Site Generator in Kotlin
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
screenshots
script
src
.gitignore
README.md
pom.xml

README.md

Kakyll

Kakyll is a static site generator similar to Hakyll (Haskell) or Jekyll (Ruby) except in Kotlin.

The primary webiste for Kakyll is http://kakyll.com. Kakyll's homesite is also built with Kakyll.

Install

brew install https://raw.githubusercontent.com/kennycason/kakyll/master/script/brew/kakyll.rb

Getting Started

First we tell Kakyll to create a new site.

kakyll new my_site

Next, navigate into the newly created site.

cd my_site

This will have pre-generate a sample blog and a pre-configured default blog structure. The blog structure and configuration are explained below.

kakyll clean kakyll build kakyll serve (also performs build) kakyll deploy

Blog Structure

.
├── templates
|   └── default.hbs
|   ├── footer.hbs
|   └── header.hbs
|   └── post.hbs
├── posts
|   ├── 2017-05-17-birth-of-kakyll.md
|   └── 2017-05-18-kotlin-is-awesome.md
├──-assets
|   ├── css
|   |   └── style.css
|   ├── js
|   |   └── scripts.js
|   ├── images
|   |   └── my_logo.png
├── index.hbs
├── about.hbs
├── tags.hbs
└── config.yml

Upon building your site, all contents will be copied to _site

Configuration

TODO explanation/table

Sample default config.yml file

title: My Blog Title
email: you@email.com
description: My Blog is about random stuff like lorem ipsum and programming. I hope you enjoy.
base_url: http://localhost:8080 # The base url to your blog. e.g. http://hakyll.com
template_engine: handlebars
deploy: rsync -avz ....         # command to execut to deploy contents in _site/*
encoding: UTF-8                 # encoding of files, defaults to UTF-8
date_format: yyyy-dd-MM         # format for date to use in post pages
posts:                          # configuration for your blog's posts
    directory: posts            # directory where your posts are located
    template: post.hbs          # optional template for posts
pages:
    - index.html
    - about.html
    - tags.html
tags:
    template: index.html
directories:
    - name: assets

Template Engine

Currently the only supported template engine is Handlebars

Markdown Engine

Kakyll used FlexMark as it's primary markdown renderer. Other options are still being considered. This will also become configurable.

Styling Your Blog

By default the blog is themed using Bootstrap based of some examples from this blog post. The author, Vijaya Anand, put together an immense and detailed post explaining how to use Bootstrap to create a nice and clean blog template.

The current default template for a post.