yufengg / millennial

A minimalist Jekyll theme for running an online publication

Millennial

A minimalist Jekyll theme for running an online publication. For everything you would ever need to know, please visit the demo site.

Quick-Start Guide

To start using Jekyll right away, fork the Millennial repository on GitHub. From there, you can rename the repository to 'USERNAME.github.io', where 'USERNAME' is your GitHub username, and edit the _config.yml file to your liking. Ensure that you have a branch named gh-pages. Your website should be ready immediately at 'http://USERNAME.github.io'.

Head over to the _posts directory to view all the posts that are currently on the website, and to see examples of what post files generally look like. You can simply just duplicate the template post and start adding your own content.

Full Installation Guide

For a full local installation of Millennial, download your own copy of Millennial and unzip it into it's own directory. From there, open up your favorite command line tool, and enter jekyll serve. Your site should be up and running locally at http://localhost:4000.

Posts

You will find this post in your _posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run jekyll serve, which launches a web server and auto-regenerates your site when a file is updated.

To add new posts, simply add a file in the _posts directory that follows the convention YYYY-MM-DD-name-of-post.ext and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works. If you already have a website built with Jekyll, simply copy over your posts.

Configuration

To change site settings, edit the _config.yml file found in the root of your repository. Anything under 'Site Settings' can be tweaked to your liking.

If you are hosting your site on GitHub Pages, then committing a change to the _config.yml file will force a rebuild of your site with Jekyll. Any changes made should be viewable soon after. If you are hosting your site locally, then you must run jekyll serve again for the changes to take place.

In the _config.yml file, you'll be able to change the title of your site along with any tagline you want, which shows up in the site header, as well as the description of your site for SEO purposes. You can also change the social media information, and add your own social media icons.

Everything Else

Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll's GitHub repo. If you have questions, you can ask them on Jekyll Talk.