materialize-jekyll 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 342391a90a545ebc5ad38c1a7dc03589bde66897
-  data.tar.gz: 34dcd13e38466dc2744c0c076ff9a65a390b45b2
+  metadata.gz: c4d0eb44056f1b66b7932ff127f5bf0a6eb6364f
+  data.tar.gz: 164e6ab5f4b5d8a27e5a21dc056509d6ebac5acb
 SHA512:
-  metadata.gz: e5fba01dff834da6dd1be02c5273f8d85f6327c032e18c31d3c153f076b0f31eb1c9350a240c1957bfaa09330a886bd494b1b43e82f865f381105560e9f2fc53
-  data.tar.gz: 40a9c856a1519ebe5b419ef19f58559ebce32461353eedcae0dd30a24cc881066f8e95773a4f7b537e64bc8feabe99c5d524e46caf3145f298f096cb78681ba1
+  metadata.gz: 1f5f17855d5b79275e141826dd3e96b66f09eaa32a0c326229ed3f94b1c94cd2facae6a8ac803296375c46134c70a5a84d7587ba63590c1d37652b16eac44965
+  data.tar.gz: 95eae0d8af2bd7bbb209a015034f86aaff2e25ba9cbc90b1f0845de2b7678f7527559ae68c9c3df448721c958d2b592e6a62b9aff97b097be001997e830f48be

data/README.md

@@ -1,8 +1,8 @@
 # materialize-jekyll
 
-Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes` and your sass in `_sass`. To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+![Materialize meets Jekyll](http://res.cloudinary.com/victorpre/image/upload/v1503466230/Gem%20materialize-jekyll/materialize-jekyll.png)
 
-TODO: Delete this and the text above, and describe your gem
+Welcome to your **materialize-jekyll** theme! This is where [Materialize](http://materializecss.com/) meets [Jekyll](https://jekyllrb.com/).
 
 ## Installation
 
@@ -28,11 +28,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
+### Project tree:
+```
+materialize-jekyll    
+│
+├─── _includes   
+|      ├─── _author.html
+|      ├─── _comments.html
+|      ├─── _date.html
+|      ├─── _footer.html
+|      ├─── _header.html
+|      ├─── _navbar.html
+│      └─── _share.html
+├─── _layouts
+│      ├─── compress.html
+│      ├─── default.html
+│      ├─── page.html
+│      └─── post.html
+├─── _posts
+│
+├─── _sass
+│      ├─── _author.scss
+│      ├─── _cards.scss
+│      ├─── _navbar.scss
+│      ├─── _post.scss
+│      ├─── _syntax.scss
+│      └─── _tags.html
+└─── assets
+     │
+     └─── css
+     │    └─── main.scss
+     └─── img
+     │    └─── icons
+     └─── js
+          ├─── init.js
+          └─── vendor
+```
+
+Inside the `_includes/` directory there are the partials that are used inside your layouts and pages.
+By default, the layouts render the following partials inside themselves:
+
+- `_layouts/default.html`
+    - `_includes/header.html`, 
+    - `_includes/navbar.html`,
+    - `_includes/footer.html`
+- `_layouts/post.html`
+    - `_includes/header.html`, 
+    - `_includes/navbar.html`,
+    - `_includes/share.html`,
+    - `_includes/author.html`,
+    - `_includes/comments.html`
+    - `_includes/footer.html`
+
+
+This gem offers two *main* layouts that you can use/edit:
+- `_layouts/default.html`, which is used in the `index.html` page (your blog homepage),
+- `_layouts/post.html`, which is the layout in which the blog post itself will be rendered
+
+
+The stylesheets of this gem can be edited both in `_sass/` and in `assets/css/main.scss`.
+
+To edit the current JavaScript functions of the gem, the file you are looking for is in `assets/js/init.js`.
+
+Your blog posts (`*.md` files) should be put in the `_posts` directory.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/victorpre/materialize-jekyll. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Development
 
@@ -42,6 +104,10 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 
 When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
 
+## Credits
+
+This theme was inspired by the [Google's Material Design](https://material.io/guidelines/#introduction-goals), using the components from [Materialize](https://github.com/Dogfalo/materialize) framework and it has a lot of influence from [Willian Justen's Card Jekyll Template](https://github.com/willianjusten/cards-jekyll-template).
+
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/footer.html

@@ -1,14 +1,18 @@
 
-    <footer class="page-footer footer-copyright z-depth-6 brown lighten-1">
+    <footer class="page-footer z-depth-6 brown lighten-1">
       <div class="container">
-        <div class="center-align brown-text text-lighten-4">© 2016 Made with <img id="love" src="assets/images/love.png"> by Victor Presumido</div>
+        <div class="footer-copyright brown lighten-1">
+          <div class="container">
+            <div class="center-align brown-text text-lighten-4">© 2017 Made with Materialize and Jekyll by Victor Presumido</div>
+          </div>
+        </div>
       </div>
     </footer>
   <!--  Scripts-->
   <script src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
   <script src="https://cdnjs.cloudflare.com/ajax/libs/materialize/0.100.1/js/materialize.min.js"></script>
   <script src="https://unpkg.com/scrollreveal/dist/scrollreveal.min.js"></script>
-	<script src="{{ "/assets/js/masonry.pkgd.min.js" | prepend: site.baseurl }}"></script>
+	<script src="{{ "/assets/js/vendor/masonry.pkgd.min.js" | prepend: site.baseurl }}"></script>
   <script src="{{ "/assets/js/init.js" | prepend: site.baseurl }}"></script>
   </body>
 </html>

data/assets/css/main.scss

@@ -66,5 +66,6 @@ p {
 
 footer.page-footer {
   margin: 0;
+  padding-top: 0px;
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: materialize-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Victor Presumido
@@ -87,12 +87,12 @@ files:
 - _layouts/page.html
 - _layouts/post.html
 - _sass/.DS_Store
+- _sass/_author.scss
+- _sass/_cards.scss
+- _sass/_navbar.scss
+- _sass/_post.scss
 - _sass/_syntax.scss
 - _sass/_tags.scss
-- _sass/author.scss
-- _sass/cards.scss
-- _sass/navbar.scss
-- _sass/post.scss
 - assets/.DS_Store
 - assets/css/.DS_Store
 - assets/css/main.scss
@@ -103,8 +103,8 @@ files:
 - assets/img/icons/linkedin.svg
 - assets/img/icons/twitter.svg
 - assets/js/init.js
-- assets/js/masonry.pkgd.min.js
-homepage: http://victorpre.com
+- assets/js/vendor/masonry.pkgd.min.js
+homepage: https://github.com/victorpre/materialize-jekyll
 licenses:
 - MIT
 metadata: {}