RubyGems - geekyll - Versions diffs - 0.0.9 → 0.1.0 - Mend

geekyll 0.0.9 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96389a92be68944de2f1f131058d86eeb7d2ce58
-  data.tar.gz: c63a0df4f714f00275b738632b84c843684c6507
+  metadata.gz: b08b4cf6175bc5e76e4100278b8a0d7f97a27a74
+  data.tar.gz: a801208baeadac463a6be29f58dc3908f5597982
 SHA512:
-  metadata.gz: a1f58f509a0864be9027bc75852282d180bf5be4bca1e266dfe9e5274d6faa3de15c8205b633deb0c60eb3fa5eaa14288615aa826f48c8cb5badc5cd2c99178f
-  data.tar.gz: 84a2eea7f28536631261f186847a2a1703bce146b936f8473e80c86b1e813d48f60de26041d3cdf4a5f9b3306d91f1a3052966bec8831e2177ab593da364cd6b
+  metadata.gz: 47b9123c7a63b42b5e45262c59c94378070e625f8576ced7fb5833e9cb4911fec62afe55f96a9ab9794ce8748fb1c99d0e72e2447f6875c4a2ba532dd7845b80
+  data.tar.gz: 66fb4f6b2cf26ad89c462f552e0ddaffb7adb6cd85b40f28bb99a59c40d61a9b134f49bf2c073bbb58bde90296d1814d63822937d580dd41dee3982b2d1d2f53

data/README.md CHANGED Viewed

@@ -1,8 +1,20 @@
-# geekyll
+# geekyll [![Gem Version](https://badge.fury.io/rb/geekyll.svg)](https://badge.fury.io/rb/geekyll)
-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!
+![geekyll sample implemetation](screenshot.png)
-TODO: Delete this and the text above, and describe your gem
+This theme has been created with one thing in mind: Displaying a summary of all site content in the landing page. Have you ever seen those landing pages (WordPress, usually) where "all" page layouts are displayed in the home page and accessible via scrolling? That's the idea.
+## What's included
+* __Google fonts__.
+* __Font awesome__. Bootstrap no longer support icons.
+* __Bootstrap 4 alpha4__. And since the whole folder of bootstrap4 is included, you can even have access to bootstrap variables and mixins!
+* __jQuery 3.0.0__.
+## Before you go
+* Live implementation: [katodia.gitlab.io](//katodia.gitlab.io).
+* [Repo](//github.com/katodia/katodia.com)
 ## Installation
@@ -28,11 +40,109 @@ Or install it yourself as:
 ## Usage
-TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
+### Front-page system
+There are only two steps to follow in order to set up the front-page system:
+- Make your default/landing page extend the *index* layout, like:
+```yaml
+---
+layout: index
+---
+<!-- No content needed here -->
+```
+- Make your pages have the following attributes:
+  -  **indexable**: *Boolean*. set it to "true".
+  -  **priority**: *Integer*. The higher its value, the higher the position of the page in both the body and navigation bar.
+  -  **class**: *String*. HTML class attribute for customizing the page style via CSS.
+  -  **icon:**: *String*. Fontawesome class for setting the icon for the navigation display, e.g : `fa-rocket`.
+### Other layouts:
+ * `root`: Sets the base structure for every sub-layout.
+ * `index`: The one you have to extend to use the front-page system.
+ * `post`: **Uncomplete**. This theme is not intended to cohabitate with blogs (yet)
+ * `page`:  this layout should be extended for single pages. When applies the front-page system attriubtes listed above, will be included in the landing page. Take in account that pages are still accessible via URI, e.g `example.org/portfolio`. This is useful for letting search engines know that your site is still divided into sections (by feed.xml)
+### Includes
+ * `analytics`: code required for tracking user activit through GA.
+ * `navigation`: will automatically search your pages for them to be listed.
+ * `image`: images can sometimes be large pieces of code. Include it every time you need to embeed images by passing the following params:
+   * //TODO: Add params
+ * `javascripts`: Contains js files to be included at the bottom of the document.
+ * `social`: Creates a list of social links in base to a map passed as an argument, .e.g:
+```yaml
+twitter: johndoe
+email: johndoe@foobar.com
+```
+* `opengrpah`: Meta tags for good looking media sharing.
+* `footer`: Three colums footer for copyright announcement,social links and featuring technologies.
+ ### _config.yml
+ This theme can be customized through:
+ * `google_analytics`: UA-XXXXX-X
+ * `social_links`: A list containing the available social platforms. E.g:
+```yaml
+social_links:
+  - platform: twitter
+    url: //twitter.com/
+    icon: fa fa-twitter
+    title: Check my Twitter profile
+  - platform: github
+    url: //github.com/
+    icon: fa fa-github
+    title: Check my Github repos
+  - platform: gitlab
+    url: //gitlab.com/
+    icon: fa fa-gitlab
+    title: Check my gitlab repos
+```
+ * `footer`: Footer data can be set like:
+```yaml
+footer:
+  copyright: Copyright &copy; 2014-2016 ...
+  featuring: Site made with A. Hosting by B.
+  socials:
+    github: katodia
+    twitter: katodians
+    email: info@katodia.com
+    googleplus: +Katodia-Desarrollo-Aplicaciones
+```
+ * `extra_js`: If you need to add more js or other misc files, do it like so:
+```yaml
+ extra_js:
+  - assets/js/contact-form.js
+  - assets/js/anchor-animation.js
+```
+* `meta`: In case you need to specify more standard meta tags:
+```yaml
+meta:
+  keywords: web, development, game, design
+  foo: bar
+```
+Output:
+```html
+<meta name"keywords" content="web, development, game, design" />
+<meta name"foo" content="bar" />
+```
 ## 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/sonirico/geekyll/issues. 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

data/_includes/analytics.html ADDED Viewed

@@ -0,0 +1,16 @@
+{% if site.google_analytics %}
+	<!-- Google Analytics -->
+	<script>
+		(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+		(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+		m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+		})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+		ga('create', '{{ site.google_analytics }}', 'auto');
+		ga('send', 'pageview', {
+		  'page': '{{ site.baseurl }}{{ page.url }}',
+		  'title': '{{ page.title | replace: "'", "\\'" }}'
+		});
+	</script>
+	<!-- End Google Analytics -->
+{% endif %}

data/_includes/head.html CHANGED Viewed

@@ -1,15 +1,16 @@
+<!-- Common metas -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 <meta http-equiv="x-ua-compatible" content="ie=edge">
-<meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+<meta name="description" content="{{ page.excerpt | default: page.description | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
 <meta name="robots" content="{{ site.meta.robots | default: 'index, follow' }}" />
 {% if site.meta.keywords %}
 <meta name="keywords" itemprop="keywords" content="{{ site.meta.keywords }}" />
 {% endif %}
+<meta name="generator" content="Jekyll v{{ jekyll.version }}" />
-<meta name="generator" content="{{ site.meta.generator | default: 'Jekyll' }}" />
+<!-- Opengraph metas -->
+{% include opengraph.html %}
 <!--
     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.4/css/bootstrap.min.css" integrity="sha384-2hfp1SzUoho7/TsGGGDaFdsuuDL0LX2hnUp6VkX3CUQ2K4K+xjboZdsXyp4oUHZj" crossorigin="anonymous">
@@ -23,5 +24,9 @@
 <link rel="stylesheet" href="{{ site.url }}/{{ css }}" />
 {% endfor %}
+{% if site.google_analytics %}
+    {% include analytics.html %}
+{% endif %}
 <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>

data/_includes/header.html CHANGED Viewed

@@ -11,7 +11,7 @@
     <div class="collapse navbar-toggleable-sm" id="navbar-header" >
         <ul class="nav navbar-nav">
-            {% include navigation.html %}
+            {% include navigation.html pages=include.pages %}
         </ul>
     </div>
 </nav>

data/_includes/navigation.html CHANGED Viewed

@@ -1,15 +1,11 @@
-{% for c_page in custom_pages %}
-    {% assign is_current = page.url == c_page.url %}
-    {% if c_page.title %}
+{% for p in include.pages %}
+    {% if p.title %}
     <li role="presentation" class="nav-item" >
-        <a title="{{ c_page.title }}" href="#{{ c_page.title | downcase }}" class="nav-link" >
-            {% if c_page.icon %}
-                <i class="fa {{ c_page.icon }}" aria-hidden="true" ></i>
-            {% endif %}
-            <span class="nav-link-text" >{{ c_page.title }}</span>
-            {% if is_current %}
-            <span class="sr-only">(página actual)</span>
+        <a title="{{ p.title }}" href="#{{ p.permalink | replace: '/', '' | downcase }}" class="nav-link" >
+            {% if p.icon %}
+                <i class="fa {{ p.icon }}" aria-hidden="true" ></i>
             {% endif %}
+            <span class="nav-link-text" >{{ p.title }}</span>
         </a>
     </li>
     {% endif %}

data/_includes/opengraph.html ADDED Viewed

@@ -0,0 +1,14 @@
+{% if page.title %}
+<meta property="title" content="{{ page.title }} - {{ site.title }}" />
+{% else %}
+<meta property="title" content="{{ site.title }}" />
+{% endif %}
+{% if page.excerpt %}
+<meta property="description" content="{{ page.excerpt | strip_html | truncate: 140 }}" />
+{% else %}
+<meta property="description" content="{{ page.description | strip_html | truncate: 140 }}" />
+{% endif %}
+<meta property="url" content="{{ page.url }}" />
+<meta property="type" content="website" />

data/_layouts/default.html CHANGED Viewed

@@ -2,9 +2,24 @@
 layout: root
 ---
-{% include header.html %}
+<div class="container-fluid"  >
+    <div class="row" >
+        <div class="col-md-3 col-lg-2 navbar-fixed-side" >
+            <header>
+                {% include header.html pages=site.pages %}
+            </header>
+        </div>
-{{ content }}
+        <div class="col-md-9 col-lg-10 offset-md-3 offset-lg-2 content" >
+            {{ content }}
+        </div>
+    </div>
+</div>
+<footer>
+    <div class="container-fluid" >
+        {% include footer.html %}
+    </div>
+</footer>
-{% include footer.html %}
 {% include javascripts.html %}

data/_layouts/index.html CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
-layout: root
-class: full_page
+layout: root
 ---
 {% assign custom_pages = site.pages | where: 'indexable', true | sort: 'priority' | reverse %}
@@ -9,7 +8,7 @@ class: full_page
     <div class="row" >
         <header>
             <div class="col-md-3 col-lg-2 navbar-fixed-side" >
-                {% include header.html %}
+                {% include header.html pages=custom_pages %}
             </div>
         </header>
@@ -20,7 +19,7 @@ class: full_page
                 <section role="main">
                     <article>
                         <header>
-                            <a name="{{ c_page.title | downcase }}" ></a>
+                            <a name="{{ c_page.permalink | replace: '/', '' | downcase }}" ></a>
                             <h1 id="{{ c_page.title | downcase }}" >
                                 {{ c_page.title }}
                             </h1>
@@ -35,6 +34,7 @@ class: full_page
                 </section>
             </div>
             {% endfor %}
         </div>
     </div> <!-- End .row -->
 </div>

data/_layouts/page.html CHANGED Viewed

@@ -1,23 +1,43 @@
 ---
-layout: default
+layout: root
 ---
-<div class="container {{ page.class | default: '' }}" >
-    <section role="main" >
-        <article>
-            {% if page.title %}
-            <header>
-                <h1>
-                    {{ page.title }}
-                </h1>
-                {% if page.summary %}
-                    <p>{{ page.summary }}</p>
-                {% endif %}
-            </header>
-            {% endif %}
-            <main>
-                {{ content }}
-            </main>
-        </article>
-    </section>
-</div>
+<div class="container-fluid"  >
+    <div class="row" >
+        <div class="col-md-10 offset-md-1 content" >
+            <div class="container {{ page.class | default: '' }}" >
+                <section role="main" >
+                    <article>
+                        {% if page.title %}
+                        <header>
+                            <h1> {{ page.title }}</h1>
+                            {% if page.summary %}
+                                <p>{{ page.summary }}</p>
+                            {% endif %}
+                        </header>
+                        {% endif %}
+                        <main role="main" itemprop="mainContentOfPage">
+                            {{ content }}
+                        </main>
+                        <footer>
+                            <p class="text-xs-center">
+                                <a href="//{{ site.url }}" title="Volver" >
+                                    <i class="fa fa-arrow-left" aria-hidden="true" ></i>Volver
+                                </a>
+                            </p>
+                        </footer>
+                    </article>
+                </section>
+            </div>
+        </div>
+    </div>
+</div>
+<footer>
+    <div class="container-fluid" >
+        {% include footer.html %}
+    </div>
+</footer>
+{% include javascripts.html %}

data/_sass/geekyll/_pages.scss CHANGED Viewed

@@ -1,3 +1,4 @@
 .container {
     max-width: 46rem;
     section[role="main"] {
@@ -19,214 +20,3 @@
     margin-top: 40px;
 }
-.no-margin-no-padding {
-    margin: 0;
-    padding: 0;
-}
-// Features "portfolio" section
-.portfolio-page {
-    .project {
-        margin-top: 10px;
-        margin-bottom: 20px;
-        //border: 1px solid rgba(0, 0, 0, 0.125);
-        .project-info {
-            // Features organization button
-            a[role="button"] {
-                border-radius: 0;
-                position: absolute;
-                top: 0px;
-                left: 0px;
-                @include media-breakpoint-down(sm) {
-                    padding: 10px;
-                    font-size: 20px;
-                }
-            }
-            // End button featuring
-            h1, h2, h3, h4, h5, h6 {
-                font-size: 20px;
-                text-align: center;
-                width: 100%;
-            }
-            background-color: #f5f5f5;
-            padding: 50px;
-            .description {
-                @extend .text-justify;
-                font-size: 15px;
-            }
-            .technologies {
-                @extend .m-x-auto;
-                @extend .text-xs-center;
-            }
-        }
-        .project-image {
-            padding: 0;
-            img {
-                @extend .img-fluid;
-            }
-        }
-    }
-}
-// Features "nosotros" section
-.us-page {
-    .card {
-        border-radius: 0;
-    }
-    img {
-        @extend .m-x-auto;
-        @extend .d-block;
-        @extend .img-fluid;
-        width: 80%;
-        margin: 2rem;
-        border-radius: 0 !important;
-    }
-    div.description {
-        @extend .text-justify;
-    }
-    div.social-container {
-        i.fa {
-            color: white;
-            display: inline-block;
-            line-height: 1;
-            padding: 0.4em;
-            border-radius: 0.1em;
-            box-shadow: inset 0 -2px 0 rgba(0,0,0,0.12);
-            .fa {
-                &.fa-code { background-color: $social_livecoding; }
-                &.fa-envelope { background-color: $social_mail; }
-                &.fa-github { background-color: $social_github;}
-                &.fa-gitlab { background-color: $social_gitlab;}
-                &.fa-linkedin { background-color: $social_linkedin;}
-                &.fa-google-plus-square { background-color:$social_google-plus-square;}
-                &.fa-twitter { background-color: $social_twitter;}
-            }
-        }
-    }
-    // Greater images on small devices
-    @include media-breakpoint-up(sm) {
-        img {
-            width: 70%;
-        }
-    }
-    @include media-breakpoint-up(md) {
-        img {
-            width: 50%;
-        }
-    }
-    @include media-breakpoint-up(lg) {
-        img {
-            width: 40%;
-        }
-    }
-}
-.presentation-page {
-    padding: 0;
-    .jumbotron {
-        background-color: #f1f3f3;
-        border-radius: 0;
-        //border: 1px solid rgba(0, 0, 0, 0.125);
-        padding: 2rem 1rem;
-        h1, h2, h3, h4, h5, h6 {
-            @extend .text-xs-center;
-        }
-        p {
-            padding: 1em;
-        }
-        img {}
-    }
-    .row {
-        margin-left: 0px;
-        margin-right: 0px;
-    }
-    .service {
-        h1, h2, h3, h4, h5, h6 {
-            @extend .text-xs-center;
-        }
-        p {
-            padding: 2em;
-            @include media-breakpoint-up (md) {
-                font-size: 0.9em;
-                padding: 0;
-            }
-            em {
-                font-style: normal;
-                font-weight: bold;
-            }
-        }
-        .fa {
-            @extend .text-xs-center;
-            width: 100%;
-            line-height: 200%;
-            font-size: 2em; // .fa-2x
-            @include media-breakpoint-down(md) {
-                font-size: 3em; // .fa-3x
-            }
-            @include media-breakpoint-down(sm) {
-                font-size: 4em;// .fa-4x
-            }
-        }
-        .fa-gamepad {
-            color: $main-color;
-        }
-        .fa-android {
-            color: #92c71c;
-        }
-        .fa-wrench {
-            color: grey;
-        }
-    }
-}
-.contact-page {
-    .row {
-        padding: 0 1em;
-    }
-}
-/* Small. Above 34em (544px) */
-/* Medium. Above 48em (768px) */
-/* Large. Above 62em (992px) */
-/* Extra large. Above 75em (1200px) */

data/screenshot.png CHANGED Viewed

Binary file

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geekyll
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - sonirico
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Geekyll strong feature is a dynamic front-page system.
+description: 'Geekyll strong feature is a dynamic front-page system. Featuring: Bootstrap
+  4, jQuery, Fontawesome.'
 email:
 - marsanben92@hotmail.com
 executables: []
@@ -61,12 +62,14 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _includes/analytics.html
 - _includes/footer.html
 - _includes/head.html
 - _includes/header.html
 - _includes/image.html
 - _includes/javascripts.html
 - _includes/navigation.html
+- _includes/opengraph.html
 - _includes/social.html
 - _layouts/default.html
 - _layouts/index.html
@@ -184,5 +187,5 @@ rubyforge_project:
 rubygems_version: 2.6.7
 signing_key:
 specification_version: 4
-summary: Geek jekyll itheme for cool organizations.
+summary: Geek jekyll theme for cool organizations.
 test_files: []