diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6ec179f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# (July 17, 2015) +* add validation for the layout type +* Make this dinamic +* fix with autors section +* Add dropdown menu for share options +* Fix error with the dropdown menu +* Add the layout config +* Add new docs and some info +* Create highlight post layout +* New Header Type +* fixed footer layout +* improve new layout for post list +* adding MDL html structure +* add material desing lite library +* Setup the jekyll project +* Initial commit + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..95cc9b9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,76 @@ +# Contributing to jekyll-mdl + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +The following is a set of guidelines for contributing to jekyll-mdl. +These are just guidelines, not rules, use your best judgment and feel free to +propose changes to this document in a pull request. + +## Submitting Issues + +* You can create an issue [here](https://github.com/gdg-managua/jekyll-mdl/issues/new), + and include as many details as possible with your report. +* Include the version of Jekyll you are using, the OS and the browser version and name. +* Include screenshots and animated GIFs whenever possible; they are immensely + helpful. +* Include the behavior you expected and other places you've seen that behavior + such as Emacs, vi, Xcode, etc. +* Check the web console for errors to include. If you can reproduce the error, use this approach to get the + full stack trace and include it in the issue. +* Perform a [cursory search](https://github.com/gdg-managua/jekyll-mdl/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+) + to see if a similar issue has already been submitted. +* Please setup a [profile picture](https://help.github.com/articles/how-do-i-set-up-my-profile-picture) + to make yourself recognizable and so we can all get to know each other better. + +## Pull Requests + +* Include screenshots and animated GIFs in your pull request whenever possible. +* Follow the [Material Design](https://www.google.com/design/spec/material-design/introduction.html) styleguides. +* End files with a newline. +* Please open an issue and reference this with your pull request +* See the [pull request guide](#pull-request-and-issue-styleguide) + +## Git Commit Messages + +* Use the present tense ("Add feature" not "Added feature") +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +* Limit the first line to 72 characters or less +* Reference issues and pull requests liberally +* Consider starting the commit message with an applicable emoji: + * :art: `:art:` when improving the format/structure of the code + * :racehorse: `:racehorse:` when improving performance + * :non-potable_water: `:non-potable_water:` when plugging memory leaks + * :memo: `:memo:` when writing docs + * :penguin: `:penguin:` when fixing something on Linux + * :apple: `:apple:` when fixing something on Mac OS + * :checkered_flag: `:checkered_flag:` when fixing something on Windows + * :bug: `:bug:` when fixing a bug + * :fire: `:fire:` when removing code or files + * :white_check_mark: `:white_check_mark:` when adding tests + * :lock: `:lock:` when dealing with security + * :arrow_up: `:arrow_up:` when upgrading dependencies + * :arrow_down: `:arrow_down:` when downgrading dependencies + * :shirt: `:shirt:` when removing linter warnings + +## Pull request and Issue Styleguide + +``` +### DESCRIPTION +The jekyll-mdl exploded my browser, some performance errors appear. + +### Trace +Here is the stack trace. + +### STEPS +1. Make a bomb. +2. Activate the bomb. +3. Place the bomb near of your browser. +4. RUN!. +5. The browser exploded. + +### EXPECTED +The jekyll-mdl dont exploded my browser. + +### REALITY +The jekyll-mdl exploded my browser. +``` diff --git a/History.md b/History.md new file mode 100644 index 0000000..fa257f7 --- /dev/null +++ b/History.md @@ -0,0 +1,19 @@ + +0.0.1 / 2015-07-17 +================== + + * add validation for the layout type + * Make this dinamic + * fix with autors section + * Add dropdown menu for share options + * Fix error with the dropdown menu + * Add the layout config + * Add new docs and some info + * Create highlight post layout + * New Header Type + * fixed footer layout + * improve new layout for post list + * adding MDL html structure + * add material desing lite library + * Setup the jekyll project + * Initial commit diff --git a/README.md b/README.md index bb672e6..e60ac5c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ # jekyll-mdl -A Jekyll theme based in Google Material Design Lite library. +> A Jekyll theme based in Google Material Design Lite library. + +## Post Configs + +All the post, require an image and maybe an author, the image are used in the cards and the autor used for the footer in the cards. For use the images and author, 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 + image: http://www.wchs4pets.org/wp-content/uploads/2015/03/cat_1-jpg.jpg + author: Google Developers Group Managua + --- + +## Layout Configs +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](https://github.com/gdg-managua/jekyll-mdl/blob/master/_config.yml) select the type of layout, rebuild the website and voilà :smile: + +## Contributing +If you want to contribute to this project, please read the [CONTRIBUTING](https://github.com/gdg-managua/jekyll-mdl/blob/master/CONTRIBUTING.md) 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](https://avatars.githubusercontent.com/u/2553459?v=3&s=100)](http://github.com/oscarmcm) | [![Byron Corrales](https://avatars.githubusercontent.com/u/99616?v=3&s=100)](https://github.com/byroncorrales) +---|--- +[Oscar Cortez](http://github.com/oscarmcm) | [Byron Corrales](https://github.com/byroncorrales) + +## License +Licensed under the Apache 2.0 license. + +See the [LICENSE](https://github.com/gdg-managua/jekyll-mdl/blob/master/LICENSE.md) file for more details. + +Copyright © 2015 [Google Developers Group Managua](http://www.gdgmanagua.org). diff --git a/_config.yml b/_config.yml index 91c2567..caea207 100644 --- a/_config.yml +++ b/_config.yml @@ -11,8 +11,9 @@ twitter_username: jekyllrb github_username: jekyll # Layout settings -header_type: fixed -post_type: highlight +header_type: default # values [ drawer, default ] +post_type: default # values [ highlight, default ] +pagination_type: default # values [ ops, default ] # Build settings markdown: kramdown diff --git a/_includes/header.html b/_includes/header.html index e14f458..b74ede9 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -23,11 +23,11 @@ - -