X-Git-Url: https://git.njae.me.uk/?a=blobdiff_plain;f=README.md;h=24aff05f11628d81278b3992f7a5812ad7780ac6;hb=bb0c8d6b1f70068f8167579f0cf7228a7f81ae60;hp=fed960471c35c64712450667ab1af533142d2320;hpb=55bf2f882d835ba5c47d1ae07dfab2d9f3cb9ce7;p=ghost-theme-willow.git diff --git a/README.md b/README.md index fed9604..24aff05 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,38 @@ -# Willow Ghost Theme -Personal, responsive, minimalist and open-source theme for Ghost blogging platform. +# Willow Ghost Theme 4.1 -## Demo -This theme is currenly being used on my [personal blog](https://raivis.com/). +Personal, responsive, minimalist and open-source theme for Ghost blogging platform. Lightweight - only 3KB of CSS and 820B of JavaScript. No jQuery, vanilla JS only. Starting version 2.0 theme is built with SASS in BEM style using ITCSS (http://itcss.io/) architecture. -## Features -- Minimalist, focuses on content; -- Incredibly lightweight theme; +![Willow Ghost Theme](http://i.imgur.com/a8WfkoS.png) -## Notes +## Theme Compatibility +Theme is fully compatible with Ghost 1.X versions. The 0.X version compatible theme can be found in "version-0.X" branch. -### Styling & Compiling +## Theme Demo -Requires Compass to be installed. +~~This theme is currently being used on my personal blog - [https://raivis.com/](https://raivis.com/).~~ Sorry, demo is no longer available - check the screenshots below or see this page for more detailed theme overview - [https://raivis.com/willow-free-responsive-minimalist-ghost-blog-theme/](https://raivis.com/willow-free-responsive-minimalist-ghost-blog-theme/) - cd content/themes/[theme-folder]/assets/scss && compass watch ./ - +## Compiling SASS & Minifying JavaScript -### 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 -### Social Links +## Editing Social Links and Promo Links -Edit the `content/themes/[theme-folder]/partials/social-links.hbs` file. \ No newline at end of file +Edit the `content/themes/[theme-folder]/partials/sidebar.hbs` file. Social links are in DIV with class `c-sidebar-contact-links` and promo links are in `c-sidebar-promotion-links` DIV - just edit the anchors added inside them. + +## Enabling Disqus Comments Box + +1. Edit the `content/themes/[theme-folder]/post.hbs` file, uncomment `` partial inclusion. + +2. Replace Disqus embed code with your site code. Edit `content/themes/[theme-folder]/partials/comments.hbs` file and replace `loadDisqusComments` function body with Disqus embed code function. + +## Screenshots + +![Homepage](http://i.imgur.com/3xg6fhy.png) +--- +![Post](http://i.imgur.com/gHunzOq.png) +--- +![Author](http://i.imgur.com/I3W07B2.png)