CSS JavaScript HTML Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Eventually - Jekyll Theme

A Jekyll version of the "Eventually" theme by HTML5 UP.

Eventually Theme

How to Use

For those unfamiliar with how Jekyll works, check out https://jekyllrb.com/ for all the details, or read up on just the basics of front matter, writing posts, and creating pages.

  • GitLab: Simply fork this repository and start editing the _config.yml file!
  • GitHub: Fork this reposity and create a branch named gh-pages, then start editing the _config.yml file! The .gitlab-ci.yml file is only needed for GitLab Pages, so feel free to delete this if you are using GitHub instead.

Added Features

  • Add your social profiles easily in _config.yml. Only social profiles buttons you enter in config.yml show up on the site footer!
  • Automatic sitemap generation via the Jekyll Sitemap Generator plugin.
  • Automatic SEO via the Jekyll SEO Tag plugin.

Credits

Original README from HTML5 UP:

Eventually by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)


Just a simple placeholder template for your kickass app/product/startup/whatever until it
launches. Includes an email signup form and a cool slideshow background (more on both below).

Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images
you can use for pretty much whatever.

(* = not included)

AJ
aj@lkn.io | @ajlkn


Signup Form:

	The signup form won't actually do anything (other than report back with a "thank you" message)
	until you tie it to either a third party service (eg. MailChimp) or your own hosted solution.
	In either case, there are two ways to go:

	1. The conventional (non-AJAX) way, which pretty much comes down to pointing the form's "action"
	attribute to your service/script URL. If you go this route, remove the entire "Signup Form" code
	block from assets/js/main.js (since it's not needed for this approach).

	-or-

	2. The AJAX way. How you set this up is largely dependent on the service/solution you're using
	so you'll need to consult their/its documentation. However, I have included some basic code
	(under "Signup Form" in assets/js/main.js) that will at least let you interact with the
	form itself.


Slideshow Background:

	This is pretty straightforward, but there are two JS settings you'll want to be aware of
	(found under "Slideshow Background" in assets/js/main.js):

	images

		The list of images to cycle through, given in the following format:

			'url': 'alignment'

		Where 'url' is the image (eg. 'assets/images/foo.jpg', 'http://somewhere.else/foo.jpg'), and
		'alignment' is how the image should be vertically aligned ('top', 'center', or 'bottom').

		Note: Browsers that don't support CSS transitions (like IE<=9) will only see the first image.

	delay

		How long to wait between transitions (in ms). Note that this must be at least twice as long as
		the transition speed itself (currently 3 seconds).


Credits:

	Demo Images:
		Unsplash (unsplash.com)

	Icons:
		Font Awesome (fortawesome.github.com/Font-Awesome)

	Other:
		html5shiv.js (@afarkas @jdalton @jon_neal @rem)
		Respond.js (j.mp/respondjs)
		Skel (skel.io)

Repository Jekyll logo icon licensed under a Creative Commons Attribution 4.0 International License.