No description

Find a file

Oscar Cortez 158a68ef84 Release v1.6.0		2015-11-01 09:24:43 -06:00
_includes	JKM-4 add support for disqus comments	2015-10-25 17:00:59 -06:00
_layouts	JKM-4 add support for disqus comments	2015-10-25 17:00:59 -06:00
_posts	Highlight multiple post	2015-10-04 20:04:47 -06:00
_sass	JKM-23 fix Unconventional use of floating action button	2015-10-31 12:24:22 -06:00
css	JKM-2 search post now work	2015-10-04 18:46:07 -06:00
img	improve new layout for post list	2015-07-11 16:05:02 -06:00
js	JKM-2 search post now work	2015-10-04 18:46:07 -06:00
.gitignore	Initial commit	2015-07-11 11:08:43 -06:00
_config.yml	JKM-4 add support for disqus comments	2015-10-25 17:00:59 -06:00
about.md	Edit the about page	2015-07-21 00:54:54 -06:00
CHANGELOG.md	Release v1.6.0	2015-11-01 09:24:43 -06:00
CONTRIBUTING.md	Create CONTRIBUTING.md file for guides	2015-07-18 21:40:13 -06:00
feed.xml	Setup the jekyll project	2015-07-11 11:36:40 -06:00
index.html	JKM-23 fix Unconventional use of floating action button	2015-10-31 12:24:22 -06:00
jekyll-mdl-screen.png	* Add demo links to the README.md	2015-07-21 09:44:31 -06:00
LICENSE	Initial commit	2015-07-11 11:08:43 -06:00
README.md	Highlight multiple post	2015-10-04 20:04:47 -06:00

README.md

jekyll-mdl

A Jekyll theme based in Google Material Design Lite library.

Demo

You can see the online demo here www.gdgmanagua.org/jekyll-mdl

Sites using jekyll-mdl

If you are using this cool jekyll theme, please open an issue or fork the project, add your site to the list and send us a pull request, we will be happy to know where the theme has been used.

fandekasp.github.io

Custom Themes

If you don't want the default site colors, you can create custom themes for the site in the mdl theme creator. The site will create a custom css, something like this:

 <link rel="stylesheet" href="https://storage.googleapis.com/code.getmdl.io/1.0.0/material.teal-green.min.css" />

Now add this in the _includes/head.html file, under the main css and enjoy your new theme.

Post Options

All the post, require an image and maybe an author and declare if the post is highlighted or not, the image are used in the cards and the autor used for the footer in the cards, the highlighted post is used for make this 12 cols and not a card, if you want to use the custom images and set the author and the highlight post, just add a new key in the post config, something like this:

---
layout: post
title:  "Welcome to jekyll-mdl"
date:   2015-07-11 11:34:20
categories: jekyll
highlight: true
image: http://www.wchs4pets.org/wp-content/uploads/2015/03/cat_1-jpg.jpg
author: Google Developers Group Managua
---

Layout Configuration

You can setup 4 types of layout

Fixed Nav + Simple Card Grid
Fixed Nav + Highlight Post + Card Grid
Drawer Nav + Simple Card Grid
Drawer Nav + Highlight Post + Card Grid

For use this in the _config.yml select the type of layout, rebuild the website and voilà 😄

Contributing

If you want to contribute to this project, please read the CONTRIBUTING file and perform the following steps

# Fork this repository
# Clone your fork
jekyll serve --watch

git checkout -b feature_branch
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send a pull request for your feature branch

Team


Oscar Cortez	Byron Corrales
Project Lead	Contributor

License

Licensed under the Apache 2.0 license.

See the LICENSE file for more details.