Skip to content

Latest commit

 

History

History
189 lines (138 loc) · 9.19 KB

theme-setup.md

File metadata and controls

189 lines (138 loc) · 9.19 KB
Raw
layout permalink title description tags image
page
/theme-setup/index.html
Theme Setup
Instructions on how to install and customize the Jekyll theme HMFAYSAL V2
Jekyll
theme
responsive
feature credit creditlink
texture-feature-02.jpg
Texture Lovers

Contents

* Auto generated table of contents {:toc}

General notes and suggestions for customizing HMFAYSAL V2.

Basic Setup

  1. Install Jekyll if you haven't already.
  2. Fork the Jekyll HMFAYSAL V2 theme repo
  3. Make it your own and customize, customize, customize.

HMFAYSAL V2 on GitHub

{% highlight text %} Jekyll-HMFAYSAL-V2-Theme/ ├── _includes/ | ├── _author-bio.html #bio stuff goes here | ├── _browser-upgrade.html #displays on IE8 and less | ├── _footer.html #site footer | ├── _head.html #site head | ├── _navigation.html #site top nav | └── _scripts.html #jQuery, plugins, GA, etc. ├── _layouts/ | ├── home.html #homepage layout | ├── page.html #page layout | ├── post-index.html #post listing layout | └── post.html #post layout ├── _posts/ ├── assets/ | ├── css/ #preprocessed less styles | ├── fonts/ #icon webfonts | ├── js/ | | ├── _main.js, main.js, modernizr.js #Main JavaScript file, plugin settings, etc | | ├── plugins #jQuery plugins | | └── vendor/ #jQuery | └── less/ ├── images/ # images for posts and pages ├── about.md # about page ├── articles.md # lists all posts from latest to oldest └── index.md # homepage. lists 5 most recent posts {% endhighlight %}

Customization

_config.yml

Most of the variables found here are used in the .html files found in _includes if you need to add or remove anything. A good place to start would be to change the title, tagline, description, and url of your site. When working locally comment out url or else you will get a bunch of broken links because they are absolute and prefixed with {{ "{{ site.url " }}}}1 in the various _includes and _layouts. Just remember to uncomment url when building for deployment or pushing to gh-pages...

Owner/Author Information

Change your name, bio, and avatar photo (100x100 pixels or larger), Twitter url, email, and Google+ url. If you want to link to an external image on Gravatar or something similiar you'll need to edit the path in _author-bio.html since it assumes it is located in \images.

Including a link to your Google+ profile has the added benefit of displaying Google Authorship in Google search results if you've went ahead and applied for it. Don't have a Google+ account? Just leave it blank.

Google Analytics and Webmaster Tools

Your Google Analytics ID goes here along with meta tags for Google Webmaster Tools and Bing Webmaster Tools site verification.

Top Navigation Links

Edit page/post titles and URLs to include in the site's navigation. For external links add external: true.

{% highlight yaml %}

sample top navigation links

links:

  • title: Home url: /
  • title: About url: /about/
  • title: Articles url: /articles/
  • title: Setup url: /theme-setup/
  • title: T-Details url: /technical-details/
  • title: The Evil-Genius url: http://www.theevilgenius.tk/ external: true {% endhighlight %}

Adding Posts and Pages

There are two main content layouts: post.html (for posts) and page.html (for pages). Both have large feature images that span the full-width of the screen, and both are meant for text heavy blog posts (or articles).

Feature Images

A good rule of thumb is to keep feature images nice and wide so you don't push the body text too far down. An image cropped around around 1024 x 256 pixels will keep file size down with an acceptable resolution for most devices. If you want to serve these images responsively I'd suggest looking at the Jekyll Picture Tag plugin2.

The two layouts make the assumption that the feature images live in the images/ folder. To add a feature image to a post or page just include the filename in the front matter like so.

{% highlight yaml %} image: feature: feature-image-filename.jpg thumb: thumbnail-image.jpg #keep it square 200x200 px is good {% endhighlight %}

If you want to apply attribution to a feature image use the following YAML front matter on posts or pages. Image credits appear directly below the feature image with a link back to the original source.

{% highlight yaml %} image: feature: feature-image-filename.jpg credit: Michael Rose #name of the person or site you want to credit creditlink: http://www.theevilgenius.tk #url to their site or licensing {% endhighlight %}

Thumbnails for OG and Twitter Cards

Post and page thumbnails work the same way. These are used by Open Graph and Twitter Cards meta tags found in _head.html. If you don't assign a thumbnail the default graphic (default-thumb.png) is used. I'd suggest changing this to something more meaningful --- your logo or avatar are good options.

Table of Contents

Any article or page that you want a table of contents to render insert the following HTML in your post before the actual content. Kramdown will take care of the rest and convert all headlines into a contents list.

PS: The TOC is hidden on small devices because I haven't gotten around to optimizing it. For now it only appears on larger screens (tablet and desktop). {: .notice}

{% highlight html %}

Contents

* Auto generated table of contents {:toc}
{% endhighlight %}

Videos

Video embeds are responsive and scale with the width of the main content block with the help of FitVids.

Not sure if this only effects Kramdown or if it's an issue with Markdown in general. But adding YouTube video embeds causes errors when building your Jekyll site. To fix add a space between the <iframe> tags and remove allowfullscreen. Example below:

{% highlight html %}

<iframe width="560" height="315" src="http://www.youtube.com/embed/PWf4WUoMXwg" frameborder="0"> </iframe> {% endhighlight %}

Theme Development

If you want to easily skin the themes' colors and fonts, take a look at variables.less in assets/less/ and make the necessary changes to the color and font variables. To make development easier I setup a Grunt build script to compile/minify the LESS files into main.min.css and lint/concatenate/minify all scripts into scripts.min.js. Install Node.js, then install Grunt, and then finally install the dependencies for the theme contained in package.json:

{% highlight bash %} npm install {% endhighlight %}

From the theme's root, use grunt to rebuild the CSS, concatenate JavaScript files, and optimize .jpg, .png, and .svg files in the images/ folder. You can also use grunt watch in combination with jekyll build --watch to watch for updates to your LESS and JS files that Grunt will then automatically re-build as you write your code which will in turn auto-generate your Jekyll site when developing locally.

And if the command line isn't your thing (you're using Jekyll so it probably is), CodeKit for Mac OS X and Prepros for Windows are great alternatives.

Questions?

Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter @hmfaysal or file a GitHub Issue. And if you make something cool with this theme feel free to let me know.

License

This theme is free and open source software, distributed under the [GNU General Public License]({{ site.url }}/LICENSE) version 2 or later. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.

Footnotes

  1. Used to generate absolute urls in sitemap.xml, feed.xml, and for canonical urls in _head.html. Don't include a trailing / in your base url ie: http://www.theevilgenius.tk. When developing locally remove or comment out this line so local .css, .js, and images are used. ↩

  2. If you're using GitHub Pages to host your site be aware that plugins are disabled. So you'll need to build your site locally and then manually deploy if you want to use this sweet plugin. ↩