X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=README.md;h=4238a39af6a4ac52fc7a4909ecea21cf4305fa53;hb=dcf1cd5add0ee12fe78f10bf8b618c744ec5128d;hp=334b06c2c60253080af8134fae7ebe1b10449deb;hpb=13e9356027c9f809b2bc9bca6c799f7af0e96217;p=ghost-theme-willow.git diff --git a/README.md b/README.md index 334b06c..4238a39 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,23 @@ -# Willow Ghost Theme -Personal, responsive, minimalist and open-source theme for Ghost blogging platform. - -## Demo -This theme is currenly being used on my [personal blog](https://raivis.com/). - -## Features -- Minimalist, focuses on content; -- Incredibly lightweight theme; +# Willow Ghost Theme 2.0 -## Notes - -### Styling & Compiling +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. -Requires Compass to be installed. +![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png) - cd content/themes/[theme-folder]/assets/scss && compass watch ./ - +## Theme Demo -### Adding Disqus +This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/). -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. +## Compiling SASS & Minifying JavaScript -### Social Links +Requires Grunt task runner & NPM to be installed. -Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file. + $ cd content/themes/[theme-folder] + $ npm install + $ grunt -### Personal Branding +## Editing Social Links and Promo Links -Update `content/themes/[theme-folder]/default.hbs` and -`content/themes/[theme-folder]/partials/mobile-header.hbs` -files to remove "John Doe" and "Lorem ipsum..." references. +Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file.