X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=README.md;h=4238a39af6a4ac52fc7a4909ecea21cf4305fa53;hb=8b10440817690f8e485ce840f376f2c02943aaa2;hp=ae860b8524abc3471703e9b460e8e52f7b41182b;hpb=806ac737ea77f788902fcc46cafed0468939f384;p=ghost-theme-willow.git diff --git a/README.md b/README.md index ae860b8..4238a39 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ -# Willow Ghost Theme +# Willow Ghost Theme 2.0 + Personal, responsive, minimalist and open-source theme for Ghost blogging platform. +Lightweight - only 2.8KB of CSS and 828B of JavaScript. No jQuery, vanilla JS only. +Version 2.0 comes with SASS in BEM style using ITCSS (http://itcss.io/) architecture. -![Willow Ghost Theme](http://i.imgur.com/gGNeWzG.png) +![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png) -## Demo -This theme is currenly being used on my [personal blog](https://raivis.com/). +## Theme Demo -### Styling & Compiling +This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/). -Requires Compass to be installed. +## Compiling SASS & Minifying JavaScript - cd content/themes/[theme-folder]/assets/scss && compass watch ./ - -### Adding Disqus +Requires Grunt task runner & NPM to be installed. -Open the `content/themes/[theme-folder]/post.hbs` file, -lookup `/* Paste Your Disqus Embed Code Here */` -line and replace it with your Disqus embed code. + $ cd content/themes/[theme-folder] + $ npm install + $ grunt -### Editing Social Links +## Editing Social Links and Promo Links -Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file. +Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.