jekyll-theme-munky 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74d7de5a20c03f3c41dea4f80729fcbf248c60b1
+  data.tar.gz: 1ec3f786e0e9dd7befdcfcfb5ada4377f32479c0
+SHA512:
+  metadata.gz: ec3faed503c0edd18750a59e4d8ada62c515c5ca7fc2601b6410acef31a6d8b314fc4deab8ffc97a786888749ba00f653c2bbdd5a89a9aec479e914ae16723e0
+  data.tar.gz: 106bbcaab9d76e3d1ccf312d646fcf8852b9f8e8d75a89699d9cd6a7727d04d400b6df45a9822f63b69d2ddbbb57575fa9bd88c8a3b87112dc9d0f7eb688a011

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Geert Ariën
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,388 @@
+# munky
+
+*Munky is a jekyll theme for portfolio websites*. It features a blog, project, photography and about page.
+
+[Theme preview](http://www.geertarien.com)
+
+![munky theme preview](/screenshot.png)
+
+## Table of contents
+
+  * [Installation](#installation)
+  * [Getting started](#getting-started)
+  * [Contents At-A-Glance](#contents-at-a-glance)
+    * [Layouts](#layouts)
+    * [Includes](#includes)
+    * [Sass](#sass)
+    * [Assets](#assets)
+  * [Usage](#usage)
+    * [General](#general)
+    * [Pages](#pages)
+    * [Blogposts](#blogposts)
+    * [Projects](#projects)
+    * [Photography gallery](#photography-gallery)
+    * [About me page](#about-me-page)
+    * [Customization](#customization)
+    * [Enabling comments (via Disqus)](#enabling-comments-via-disqus)
+    * [Enabling Google Analytics](#enabling-google-analytics)
+  * [Contributing](#contributing)
+  * [License](#license)
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem "jekyll-theme-munky"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-munky
+```
+
+And then execute:
+
+    $ bundle
+
+## Getting started
+
+Wether you're using munkye as a theme gem or as a fork, the easiest way to
+get started is to copy the content from the `demo` folder to your jekyll
+website's root folder. It adds all the required files and settings
+to get the most of out of the theme and adds some example data to get started.
+
+As a bare minimum for the theme to work properly you will need to add the
+following configuration data to the `_config.yml` file:
+
+```yaml
+  defaults:
+    - scope:
+        path: ""
+      values:
+        image: /assets/images/logo.png
+    -
+      scope:
+        path: ""
+        type: "posts"
+      values:
+        type: "post"
+    -
+      scope:
+        path: ""
+        type: "projects"
+      values:
+        type: "project"
+```
+
+## Contents At-A-Glance
+
+### Layouts
+
+Refers to files within the `_layouts` directory, that define the markup for your theme.
+
+  - `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`.
+  - `blog.html` — The layout for your landing-page / home-page / index-page.
+  - `page.html` — The layout for your documents that contain FrontMatter, but are not posts.
+  - `post.html` — The layout for your posts and projects.
+  - `about.html` — The layout for your about-page.
+  - `photography.html` — The layout for your photography-page.
+  - `projects.html` — The layout for your projects-page.
+
+### Includes
+
+Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
+
+  - `disqus_comments.html` — Code to markup disqus comment box.
+  - `footer.html` — Defines the site's footer section.
+  - `google-analytics.html` — Inserts Google Analytics module (active only in production environment).
+  - `head.html` &mdash; Code-block that defines the `<head></head>` in *default* layout.
+  - `header.html` &mdash; Defines the site's main header section.
+  - `sidebar.html` &mdash; Defines the site's sidebar section.
+  - `github-buttons.html` &mdash; Inserts github repository buttons for projects.
+  - `share-buttons.html` &mdash; Inserts social media share buttons for projects and posts.
+  - `image.html` &mdash; Defines how are images defined in markdown are generated.
+
+### Sass
+
+Refers to `.scss` files within the `_sass` directory that define the theme's styles.
+
+  - `munky.scss` &mdash; The core file imported by preprocessed `main.scss`, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.
+  - `munky/*.scss` &mdash; Sass partials that are imported by `munky.scss`.
+  - `font-awesome/font-awesome.scss` &mdash; Imports sass partials for font-awesome icons.
+
+### Assets
+
+Refers to various asset files within the `assets` directory.
+Contains the `main.scss` that imports sass files from within the `_sass`
+directory. This `main.scss` is what gets processed into the theme's main
+stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`.
+
+This directory can include sub-directories to manage assets of similar type,
+and will be copied over as is, to the final transformed site directory.
+
+The following sub-directories are required:
+
+  - `css` &mdash; Contains the main `.scss` file as well as the `simplelightbox.scss` file for the configuration of the photo gallery.
+  - `downloads` &mdash; Place downloadable content for projects in this directory.
+  - `fonts` &mdash; Contains font-awesome font files for icons.
+  - `javascripts` &mdash; Directory with jquery, simple-lightbox and custom javascript files.
+  - `images` &mdash; The root directory contains side wide images such as logos and profile pictures.
+    - `photography` &mdash; Place photographs with their thumbnails in this directory.
+    - `posts` &mdash; Images for the posts, each post has his own sub-directory corresponding with the markdown filename.
+    - `projects` &mdash; Images for the projects, each project has his own sub-directory corresponding with the markdown filename.
+
+## Usage
+
+### General
+
+#### Logo
+
+To change the header logo replace the `/assets/images/logo-transparent.png`
+image:
+
+```
+assets
+└───images
+    └───profile-transparent.png
+```
+
+For maximum compatibility use an image with a height of 236 pixels and a
+transparent background.
+
+#### Email
+
+A link to your email address is provided in the _footer_, _sidebar_ and _about page_.
+For this to work your email address needs to be configured in your `_config.yml` file:
+
+```yaml
+email: virtual@munky.com
+```
+
+The link to your email is set using javascript to mislead basic web crawlers. It
+is still advised to use an email service with a strong spam filter.
+
+#### Social media links
+
+Your social media links are displayed in the _footer_, _sidebar_ and _about page_.
+They need to be configured in your `_config.yml` file:
+
+```yaml
+twitter:
+  username: accountname
+linkedin:
+  username: accountname
+github:
+  username: accountname
+flickr:
+  username: accountname
+```
+
+**Don't forget to set up your github username if you're gonna link to
+repositories in your projects.**
+
+#### Sidebar
+
+Change the following data in your `_config.yml` file to change the information
+in the sidebar:
+
+```yaml
+author:
+  name: Virtual Munky
+  bio: Jekyll theme for portfolio websites
+  location: Antwerp, BE
+```
+
+To change the rounded profile picture replace the `/assets/images/profile-small.jpg`
+image:
+
+```
+assets
+└───images
+    └───profile-small.jpg
+```
+
+#### Images
+
+In markdown files you can use the following syntax to render images with
+(or without) captions:
+
+```markdown
+{% include image.html
+name="example.jpg"
+caption="Est orci, gravida pede vestibulum sodales pellentesque neque condimentum, occaecat luctus fermentum."
+alt="example"
+%}
+```
+
+### Pages
+
+On top of the default FrontMatter variables, munky theme also uses
+the following variables:
+
+```yaml
+  order: 2        # Used for ordering page links in navigation menu's.
+  sidebar: true   # Enable or disable the author info sidebar.
+  text: true      # Set true to change the main content width to a more readable format.
+  custom_css:     # Add custom css to a page.
+  - simplelightbox
+  custom_js:      # Add custom javascript to a page.
+  - simple-lightbox.min
+  - gallery
+```
+
+The following markdown files are required in your jekyll site's root folder:
+
+  - `index.md` &mdash; Layout: *blog*
+  - `projects.md` &mdash; Layout: *projects*
+  - `photography.md` &mdash; Layout: *photography*
+  - `about.md` &mdash; Layout: *about*
+
+### Blogposts
+
+Blogposts follow the default jekyll standard. Exclusive to posts is the
+`last_modified_at` FrontMatter variable. This variable, that is also
+used by the jekyll-seo-tag plugin, shows the date the post was last changed
+below the title.
+
+```yaml
+  last_modified_at: 2017-04-07
+```
+
+Images that are used in blogposts should be placed inside a separate directory,
+with the same name as the post's filename, inside the `/assets/images/posts/`
+directory:
+
+```
+assets
+└───images
+    └───posts
+        └───2017-04-01-example-post
+             │   image01.jpg
+             │   ...
+```
+
+### Projects
+
+Projects use the *post* layout but add some extra features through the following
+FrontMatter variables:
+
+```yaml
+  # The description for the project overview page.
+  description: Ultrices dapibus felis dolor sed, augue scelerisque, ante ligula
+               aenean aliquam feugiat eget.
+  # Link to the github repository of the project. To use this feature you need
+  # to set the name of your github account in _config.yml .
+  repo: example
+  # Only in case the repo is not set, you can use the download variable to link
+  # to a file in the /assets/download directory.
+  download: example.zip
+  # Link to the image for the project overview page.
+  image: /assets/images/projects/example.jpg
+```
+
+Images that are used in projects should be placed inside a separate directory,
+with the same name as the project's filename, inside the
+`/assets/images/projects/` directory:
+
+```
+assets
+└───images
+    └───projects
+        └───example-project
+             │   image01.jpg
+             │   ...
+```
+
+### Photography gallery
+
+To add images to the photography page, simply add the images to the
+`/assets/images/photography/` directory along with a thumbnail version named
+`<filename>_thumb.<extension>`:
+
+```
+assets
+└───images
+    └───photography
+         │   01_thumb.jpg
+         │   01.jpg
+         │   02_thumb.jpg
+         │   02.jpg
+         │   ...
+```
+
+### About me page
+
+A caption below the title can be set using FrontMatter:
+
+  ```yaml
+    caption: Super awesome caption.
+  ```
+
+To change the profile picture replace the `/assets/images/profile.jpg` image:
+
+```
+assets
+└───images
+    └───profile.jpg
+```
+
+### Customization
+
+#### General
+
+To override the default structure and style of munky, simply create the
+concerned directory at the root of your site, copy the file you wish to
+customize to that directory, and then edit the file.
+e.g., to override the [`_includes/head.html `](_includes/head.html) file to
+ specify a custom style path, create an `_includes` directory, copy
+ `_includes/head.html` from munky gem folder to `<yoursite>/_includes` and start
+  editing that file.
+
+#### CSS
+
+To **configure the munky SCSS variables**, the `munky.scss` file has to exist at your site source:
+
+  - Create  a new file `munky.scss` at `<your-site>/_sass/`
+  - Copy the contents at [_sass/munky.scss](_sass/munky.scss) onto the `munky.scss` you just created, and edit away!
+
+To **override the default CSS**, the `main.scss` file has to exist at your site source:
+
+  - Create  a new file `main.scss` at `<your-site>/assets/css/`
+  - Copy the contents at [assets/css/main.scss](assets/css/main.scss) onto the `main.scss` you just created, and edit away!
+
+### Enabling comments (via Disqus)
+
+Optionally, if you have a Disqus account, you can tell Jekyll to use it to show
+a comments section below each post.
+
+To enable it, add the following lines to your Jekyll site's `_config.yml`:
+
+```yaml
+  disqus:
+    shortname: my_disqus_shortname
+```
+
+You can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208).
+
+Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`
+
+
+### Enabling Google Analytics
+
+To enable Google Anaytics, add the following lines to your Jekyll site's `_config.yml`:
+
+```yaml
+  google_analytics: UA-NNNNNNNN-N
+```
+
+Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GeertArien/jekyll-theme-munky.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/_includes/disqus_comments.html

@@ -0,0 +1,17 @@
+  <div id="disqus_thread" class="col-100"></div>
+  <script>
+    var disqus_config = function () {
+      this.page.url = '{{ page.url | absolute_url }}';
+      this.page.identifier = '{{ page.url | absolute_url }}';
+    };
+
+    (function() {
+      var d = document, s = d.createElement('script');
+
+      s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
+
+      s.setAttribute('data-timestamp', +new Date());
+      (d.head || d.body).appendChild(s);
+    })();
+  </script>
+  <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>

data/_includes/footer.html

@@ -0,0 +1,96 @@
+<footer>
+    <div id="foot-nav" class="group">
+        <div class="col-25">
+            <p>
+              <strong>Site Map</strong>
+            </p>
+
+            <ul class="pages">
+              {% assign sorted_pages = site.pages | sort:"order" %}
+              {% for node in sorted_pages %}
+                {% if node.title and node.order %}
+                <li class="nav-link">
+                  <a class="reverse" href="{{ node.url | relative_url }}">{{ node.title | escape }}</a>
+                </li>
+                {% endif %}
+              {% endfor %}
+            </ul>
+        </div>
+
+        <div class="col-25">
+
+            <p>
+              <strong>Contact</strong>
+            </p>
+
+            <ul class="social-media-list">
+                <li>
+                    <a class="reverse email" href="" title="Send me an email">
+                        <span class="username">Email</span>
+                    </a>
+                </li>
+
+                {% if site.linkedin.username %}
+                  <li>
+                      <a class="reverse" href="https://www.linkedin.com/in/{{ site.linkedin.username }}" title="Follow me on LinkedIn">
+                          <span class="username">LinkedIn</span>
+                      </a>
+                  </li>
+                {% endif %}
+
+                {% if site.github.username %}
+                  <li>
+                      <a class="reverse" href="https://github.com/{{ site.github.username }}" title="Follow me on GitHub">
+                          <span class="username">GitHub</span>
+                      </a>
+                  </li>
+                {% endif %}
+
+                {% if site.flickr.username %}
+                  <li>
+                      <a class="reverse" href="https://www.flickr.com/photos/{{ site.flickr.username }}/" title="Connect with me on Flickr">
+                          <span class="username">Flickr</span>
+                      </a>
+                  </li>
+                {% endif %}
+
+                {% if site.twitter.username %}
+                  <li>
+                      <a class="reverse" href="https://twitter.com/{{ site.twitter.username }}/" title="Follow me on Twitter">
+                          <span class="username">Twitter</span>
+                      </a>
+                  </li>
+                {% endif %}
+
+                {% if site.instagram.username %}
+                  <li>
+                      <a class="reverse" href="https://www.instagram.com/{{ site.instagram.username }}/" title="Connect with me on Instagram">
+                          <span class="username">Instagram</span>
+                      </a>
+                  </li>
+                {% endif %}
+
+            </ul>
+        </div>
+
+        <div class="col-50">
+            <p id="rss-subscribe"><strong>Subscribe <a class="reverse underline" href="/feed.xml">via RSS</a></strong></p>
+            <p id="poweredby">Powered by
+              <a class="reverse" href="https://jekyllrb.com/">Jekyll</a>,
+              <a class="reverse" href="http://sass-lang.com/">Sass</a>,
+              <a class="reverse" href="https://jquery.com/">Jquery</a>,
+              <a class="reverse" href="https://disqus.com/">Disqus</a>,
+              <a class="reverse" href="https://www.andrerinas.de/simplelightbox.html">Simplelightbox</a>
+              and <a class="reverse" href="https://pages.github.com/">GitHub Pages</a>.
+            </p>
+        </div>
+
+    </div>
+
+    <div id="disclaimer">
+      <p>
+        Copyright © <span id="year"></span> <a class="reverse email" href="">{{ site.author.name | escape }}</a>.
+      </p>
+    </div>
+
+</footer>