Skip to content

eiriksm/kyll-thrill

Repository files navigation

kyll-thrill

Build Status Coverage Status devDependency Status Code Climate

It's a blog tool that clocks in at < 7kb and 1 HTTP request.

Getting started.

  • Clone this repo.
  • Edit the appropriate settings (_config.yml)
  • Write some posts (see Jekyll docs for info).
  • Publish to github (see Jekyll docs for info).

Customizing

  • Make sure you have npm and jekyll installed.
  • Install gulp with [sudo] npm install -g gulp
  • Install all dependencies with npm install.

Themes

By default, kyll-thrill comes with one theme: thrill. If you want to make your own theme, you can start with just copying the folder ./themes/thrill into another folder in themes.

Next step is to tell the config you will be using another theme. Edit at the appropriate place in _config.yml

At last, make sure you compile templates, javascripts and css from your theme. The workflow is as follows:

  • Compile assets for production with gulp
  • All javascript and css are put inline. Compile inline with gulp inline.
  • A nifty command is make compile which will do the following for you:
    • gulp
    • gulp inline
    • JEKYLL_ENV='development' jekyll serve -w --baseurl "" --trace

Note:

  • Remember to only edit templates/*.html in your theme if you are doing changes. This is the template for compiling inline.
  • For development this command is handy: JEKYLL_ENV='development' jekyll serve -w --baseurl ""
  • Have fun, be awesome.

Tests

Tests are run with Karma. The default setup for karma is running them through PhantomJS, but you can look in karma.conf.js to see how you can also run them for example in Chrome.

All tests are run with make test

Licence

MIT.

About

< 7kb / 1 HTTP request blog tool

Resources

Stars

Watchers

Forks

Packages

No packages published