Skip to content
Branch: gh-pages
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes Change to https Jun 13, 2016
_layouts Add first commit (mock) Aug 4, 2015
_posts Add license and steps to setup theme Aug 4, 2015
assets Change to https Jun 13, 2016
src Change to https Jun 13, 2016
.gitignore Add first commit (mock) Aug 4, 2015
CNAME Remove CNAME Aug 4, 2015
LICENSE Update License May 8, 2016
Readme.md
_config.yml Add baseurl Jul 19, 2016
about.html Edit about me Aug 4, 2015
feed.xml Add first commit (mock) Aug 4, 2015
gulpfile.js Corrected multiple development environment problem (#42) Jul 1, 2016
index.html fix author site url (#32) Jun 1, 2016
initpost.sh Fix conflict #27 May 20, 2016
package.json In the package.json, instead of ISC license. It should show MIT. (#55) Mar 11, 2018
robots.txt Add first commit (mock) Aug 4, 2015
screenshot.png
search.json Add first commit (mock) Aug 4, 2015
series.html fix series.html baseurl (#34) Jun 3, 2016
sitemap.xml Add first commit (mock) Aug 4, 2015
tags.html Edit tags Nov 29, 2015

Readme.md

Will Jekyll Template - Demo

Screenshot

This is a simple and minimalist template for Jekyll designed for developers that want to write blog posts but don't want to care about frontend stuff.

The Theme features:

  • Gulp
  • Stylus (Jeet, Rupture, Kouto Swiss)
  • Smoothscroll
  • Live Search
  • Offcanvas Menu
  • SVG icons
  • Very very small and fast!
  • Shell Script to create posts
  • Tags page
  • Series page
  • About Me page
  • Feed RSS
  • Sitemap.xml
  • Color Customization
  • Info Customization

Basic Setup

  1. Install Jekyll
  2. Fork the Will Jekyll Template
  3. Clone the repo you just forked.
  4. Edit _config.yml to personalize your site.
  5. Check out the sample posts in _posts to see examples for assigning categories and tags, and other YAML data.
  6. Read the documentation below for further customization pointers and documentation.
  7. Remember to compile your assets files with Gulp.

Site and User Settings

You have to fill some informations on _config.yml to customize your site.

# Site settings
description: A blog about lorem ipsum dolor sit amet
baseurl: "" # the subpath of your site, e.g. /blog/
url: "http://localhost:3000" # the base hostname & protocol for your site 

# User settings
username: Lorem Ipsum
user_description: Anon Developer at Lorem Ipsum Dolor
user_title: Anon Developer
email: anon@anon.com
twitter_username: lorem_ipsum
github_username:  lorem_ipsum
gplus_username:  lorem_ipsum
disqus_username: lorem_ipsum

Don't forget to change your baseurl before build your site!

Color customization

All color variables are in src/styl/variable. To change the main color, just set the new value at main assignment. Another colors are for texts and the code background color.

Creating posts

You can use the initpost.sh to create your new posts. Just follow the command:

./initpost.sh -c Post Title

The new file will be created at _posts with this format date-title.md.

Front-matter

When you create a new post, you need to fill the post information in the front-matter, follow this example:

---
layout: post
title: "How to use"
date: 2015-08-03 03:32:44
image: '/assets/img/post-image.png'
description: 'First steps to use this template'
tags:
- jekyll 
- template 
categories:
- I love Jekyll
twitter_text: 'How to install and use this template'
---

Running the blog in local

In order to compile the assets and run Jekyll on local you need to follow those steps:

  • Install NodeJS
  • Run npm install
  • Run gulp

Questions

Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter @willian_justen or file a GitHub Issue.

Donation

If you liked my work, buy me a coffee <3

paypal

License

This theme is free and open source software, distributed under the The MIT License. So feel free to use this Jekyll theme on your site without linking back to me or using a disclaimer.

If you’d like to give me credit somewhere on your blog or tweet a shout out to @willian_justen, that would be pretty sweet.

You can’t perform that action at this time.