academic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 876a078617bf34b4ec0059b05f85b733aecc2e07
+  data.tar.gz: 8db534703a9220279f8de5bc343bdb70a8f9e4de
+SHA512:
+  metadata.gz: 5544ca70d78d0b14eae435a8278da7f53c98fc7ff1dd8ecfa43c5b7debe2d67ca0f8f73fa3d1b4a6cf1f8b6b444063991f60dc5fcee3059edf337edd3271c691
+  data.tar.gz: 3f083fd73fb328c8b95d801002f6282dc22bab811ce7c310d9407a2326db4bbc1cb1bac02ef113a05cbc00cf7dbe78af3ccf82967048ed1fd9d88335bb2d2df9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 batlab
+
+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,197 @@
+# academic
+
+Academic is a theme with a focus on simplicity, typography and flexibility. I originally designed for my personal blog during my PhD thesis.
+
+![Academic screenshot](screenshot.png)
+
+**Simplicity**: both in design and configuration, Academic aims to let the writer and its readers focus on the content.
+
+**Typography**: the goal of Academic is to let the author write very long and detailed posts, while being kind to its readers' eyes.
+
+**Flexibility**: Academic can be used to generate different layouts while keeping the same look and feel.
+
+---
+
+Table of contents:
+
+
+* [Features](#features)
+* [Installation](#installation)
+* [Usage](#usage)
+	* [Change the brand color](#change-the-brand-color)
+	* [Setup your `_config.yml` file](#setup-your-_config-yml-file)
+		* [General settings](#general-settings)
+		* [Author](#author)
+		* [Navigation menu](#navigation-menu)
+	* [Layouts](#layouts)
+		* [Post layout](#post-layout)
+		* [Page layout](#page-layout)
+		* [About layout](#about-layout)
+		* [Archive layout](#archive-layout)
+* [Contributing](#contributing)
+* [Release log](#release-log)
+* [License](#license)
+
+## Features
+
++ **Responsive design** on every page
++ Designed with **typography best practices** (and my own tastes) in mind:
+    + Simple but elegant fonts, with modular scale
+    + High contrast colors and backgrounds as much as possible ([read more](http://contrastrebellion.com/), [and more](https://backchannel.com/how-the-web-became-unreadable-a781ddc711b6))
+    + Comfortable line length (around 66 characters, [read more](http://webtypography.net/2.1.2))
+    + Attention to vertical rhythm, law of proximity and so on ([read more](http://typographyhandbook.com/))
++ Add an **image thumbnail** to illustrate your posts. It's displayed both on the post list and on the post itself.
++ Add a **summary** to your posts. It's used in the posts lists and on the post itself.
++ **MathJax** support (loaded only on posts layouts)
++ **Tables and footnotes** styled by default (with the `redcarpet` markdown engine)
++ Add your name and a shortbio at the end of each post
++ Easily add a "call to action" (links to the RSS feed and your Twitter if you gave your username in the `_config.yml` file) at the end of each post and on your homepage
++ If you want to, **add a Creative Commons license** to your website directly from your `_config.yml` file
++ **About page**:
+    + Responsive two-columns layout
+    + Just fill out your usernames for Twitter, Github, LinkedIn, Keybase ; contact email or personal website ; link to your curriculum vitae.
+    + Academic automatically loads your Github profile picture.
++ Choose between a **navigation menu** at the top or a **short pitch** for your blog
++ Set a `dateformat` for the whole website directly from the `_config.yml` file
++ Navigation menu:
+    + Hide pages from the navigation menu
+    + Add external links in the menu from the `_config.yml` file
++ 404 page layout
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem "academic"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: academic
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install academic
+```
+
+I suggest you install and use `redcarpet` to generate your markdown ([read more](http://jekyllrb.com/docs/configuration/#redcarpet)).
+
+## Usage
+
+### Change the brand color
+
+Academic uses 4 shades of grey (very dark grey for the main content, ligther greys to lessen the emphasis on some elements) and a single "brand" color.
+
+By default, the brand color is `#d33682` (purple). If it's not to your taste, you can easily change it by overriding the `$brand-color` variable in `/assets/styles.scss`.
+
+```scss
+$brand-color: red;
+```
+
+### Setup your `_config.yml` file
+
+#### General settings
+
+`title_html`: [optional] you can style the title of your website with html elements.
+
+Example:
+
+```html
+title_html: "<b>hello</b>world"
+```
+
+`pitch`: [optional] a small sentence or motto to quickly describe your blog. If no pitch is detected, Academic will fill the top bar with a navigation menu. If you want to display a short description for your website, Academic will NOT generate a navigation menu. Please note that `pitch` is only used in the top bar ; it is different from the `description` field (used in the footer and the meta tags for search engines).
+
+`description`: [recommended] short description for search engines. It's displayed in the footer of every page. Not to be confused with `pitch`.
+
+`cc`: [optional] choose among the [Creative Commons](https://creativecommons.org/licenses/) licenses (v4). Accepted values are : `by`, `by-sa`, `by-nd`, `by-nc`, `by-nc-sa`, `by-nc-nd`. Defining the `cc` variable will add a small sentence in the footer. If no value is given, a small copyright is added instead.
+
+
+`dateformat`: [optional] format the dates of the whole website. Default "%b %-d, %Y". Read [the documentation](https://help.shopify.com/themes/liquid/filters/additional-filters#date) to learn how you can customize the date format.
+
+#### Author
+
+`email`: [optional] add email address in about layout.
+
+`curriculum`: [optional]
+
++ `name`: [optional] text of the link. Default : Curriculum Vitae.
++ `url`: [mandatory] url of the curriculum file.
+
+`shortbio`: [optional] describe yourself in a sentence or two. If `shortbio` is defined, a small element is added at the end of the post to introduce the author to the readers.
+
+`author_display`: [optional] if `true`, the author's name (and `author_website`) is added in the footer. `false` by default.
+
+`author_website`: [optional] url to the external website of the author. If `author_website` exists, it is added in the about layout and in the footer (if `author_display` is `true`).
+
+`twitter_username`: [optional] your Twitter username. If it exists, your account will be linked in the "call to action" boxes (homepage and posts), in the footer and on the about page.
+
+`github_username`: [optional] your Github username. If it exists, your account will be linked in the footer and on the about page.
+
+`keybase_username`: [optional] your Keybase username. If it exists, your account will be linked on the about page.
+
+`linkedin_username`: [optional] your LinkedIn username. If it exists, your account will be linked on the about page.
+
+#### Navigation menu
+
+`nav_ext_links`: [optional] you can choose to add external links in the top bar. Each item has two attributes:
+
++ `name`: [mandatory] text for the link
++ `url`: [mandatory] url
+
+Example:
+
+```yaml
+nav_ext_links:
+  - name: Link 1
+    url: http://jupiterbroadcasting.com/
+  - name: Link 2
+    url: http://wallabag.org/
+```
+
+### Layouts
+
+#### Post layout
+
+In the yaml header, you can add some tags to help Academic.
+
+`summary`: [optional] a short text or abstract. Used in the posts lists and on the post page.
+
+`thumbnail`: [optional] relative path to image or absolute url to an image that describes your post. Used in the posts lists and on the post page.
+
+#### Page layout
+
+In the yaml header, you can add some tags to help Academic.
+
+`invisible`: [optional] if `true`, then this page will not be listed in the navigation menu.
+
+#### About layout
+
+Will automatically put the content of the page on the right column. The left column will automatically be filled with the author info provided in the `_config.yml`.
+
+#### Archive layout
+
+Pages with the archive layout will list all posts published in reverse chronological order.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gaalcaras/academic. 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.
+
+## Release log
+
++ 0.1.0 : first release of the theme.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/_includes/calltoaction.html

@@ -0,0 +1,9 @@
+<div class="colored-block">
+  {% if include.message %}
+  {{ include.message | escape }}
+  {% endif %}
+  Vous pouvez vous abonner au <a href="/feed.xml">fil RSS</a> du blog
+  {% if site.twitter_username %}
+   ou suivre <a href="https://twitter.com/{{ site.twitter_username }}">@{{ site.twitter_username }}</a> sur Twitter
+  {% endif %}.
+</div>

data/_includes/date.html

@@ -0,0 +1,10 @@
+{% if site.dateformat %}
+  {% assign months = "Janvier, Février, Mars, Avril, Mai, Juin, Juillet, Août, Septembre, Octobre, Novembre, Décembre" | downcase | split: ", " %}
+  {% assign date = include.date | date: site.dateformat %}
+  {% assign eng_month = include.date | date: "%B" %}
+  {% assign num_month = include.date | date: "%m" | minus: 1 %}
+
+  {{ date | replace:eng_month, months[num_month] }}
+{% else %}
+  {{ include.date | date: "%b %-d, %Y" }}
+{% endif %}

data/_includes/footer.html

@@ -0,0 +1,73 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+
+      <ul class="info-list footer-col">
+        {% if site.title %}
+        <li><a href="{{ "/" | relative_url}}">{{ site.title_html }}</a>
+        {% endif %}
+
+        {% if site.author_display %}
+        <span class="author"> par
+          {% if site.author_website %}
+          <a target="_blank" href="{{ site.author_website }}">{{ site.author }}</a>
+          {% else %}
+          {{ site.author }}
+          {% endif %}
+        </span>
+        </li>
+        {% endif %}
+
+        {% if site.description %}
+        <li>{{ site.description }}</li>
+        {% endif %}
+
+      </ul>
+
+      <ul class="follow-list footer-col">
+        <li> </li>
+
+        <li>
+          <a href="/feed.xml">RSS</a>
+        </li>
+
+        {% if site.twitter_username %}
+        <li><a href="https://twitter.com/{{ site.twitter_username }}">Twitter</a></li>
+        {% endif %}
+
+        {% if site.github_username  %}
+        <li><a href="https://github.com/{{ site.github_username }}">Github</a></li>
+        {% endif %}
+
+      </ul>
+
+    <div class="bottom">
+      <div class="tech">
+        <a href="https://jekyllrb.com/">Jekyll</a> + Academic
+      </div>
+      <div class="legal">
+      {% if site.cc == null %}©{% endif %}
+        {% if site.title %}
+        <a href="{{ "/" | relative_url}}">{{ site.title | escape }}</a>
+        {% endif %}
+      {% assign oldest_post = site.posts reversed | first %}
+      {% assign oldest = oldest_post.date | date: "%Y" %}
+      {% assign newest = site.time | date: "%Y" %}
+      ({% if oldest != newest %}{{ oldest }}-{% endif %}{{ newest }})
+      {% if site.author %}
+        par <a target="_blank" href="{{ site.author_website }}">{{ site.author }}</a> 
+      {% endif %}
+      {% if site.cc %}
+      est placé sous licence <a target="_blank" rel="license" href="https://creativecommons.org/licenses/{{ site.cc }}/4.0/" class="cc-licence">CC {{ site.cc }}</a>
+      {% endif %}
+           </div>
+    </div>
+  </div>
+</footer>
+
+{% if page.layout == "post" %}
+<script type="text/javascript" async
+  src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML">
+</script>
+{% endif %}
+

data/_includes/head.html

@@ -0,0 +1,15 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+
+  <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ "/feed.xml" | relative_url }}">
+  
+  {% if jekyll.environment == 'production' %}
+  {% endif %}
+</head>

data/_includes/header.html

@@ -0,0 +1,52 @@
+<header class="site-header" role="banner">
+
+  <div class="wrapper">
+
+    {% if site.pitch %}
+      {% assign title_class = "site-title with-pitch" %}
+    {% else %}
+      {% assign title_class = "site-title" %}
+    {% endif %}
+
+    {% if site.title_html %}
+      {% assign title = site.title_html %}
+    {% else %}
+      {% assign title = site.title escape %}
+    {% endif %}
+
+    <a class="{{ title_class }}" href="{{ "/" | relative_url}}">{{ title }}</a>
+    {% if site.pitch %}
+    <span class="site-pitch">{{ site.pitch | espace }}</span>
+    {% endif %}
+
+    {% if site.pitch == null %}
+    <nav class="site-nav">
+      <span class="menu-icon">
+        <svg viewBox="0 0 18 15" width="18px" height="15px">
+          <path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
+          <path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
+          <path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
+        </svg>
+      </span>
+
+      <div class="trigger">
+        {% for link in site.nav_ext_links %}
+            {% if link.url and link.name %}
+            <a target="_blank" class="page-link" href="{{ link.url }}">{{ link.name | escape }}</a>
+            {% endif %}
+        {% endfor %}
+
+        {% for my_page in site.pages %}
+          {% unless my_page.invisible %}
+            {% if my_page.title %}
+            <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            {% endif %}
+          {% endunless %}
+        {% endfor %}
+      </div>
+    </nav>
+    {% endif %}
+
+  </div>
+
+</header>

data/_includes/icon-email.html

@@ -0,0 +1 @@
+<a href="mailto:{{site.email}}"><span class="icon icon--email">{% include icon-email.svg %}</span><span class="username">{{ include.username }}</span></span></a>

data/_includes/icon-email.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 24 24" width="16px" height="16px"><path fill="#828282" d="M20 4H4c-1.1 0-1.99.9-1.99 2L2 18c0 1.1.9 2 2 2h16c1.1 0 2-.9 2-2V6c0-1.1-.9-2-2-2zm0 4l-8 5-8-5V6l8 5 8-5v2z"/></svg>

data/_includes/icon-file.html

@@ -0,0 +1,10 @@
+<a href="{{ include.curriculum.url }}"><span class="icon icon--cv">{% include icon-file.svg %}</span>
+  <span class="username">
+    {% if include.curriculum.name %}
+    {{ include.curriculum.name }}
+    {% else %}
+    Curriculum Vitae
+    {% endif %}
+  </span>
+</a>
+

data/_includes/icon-file.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 24 24" width="16px" height="16px"><path fill="#828282" d="M6 2c-1.1 0-1.99.9-1.99 2L4 20c0 1.1.89 2 1.99 2H18c1.1 0 2-.9 2-2V8l-6-6H6zm7 7V3.5L18.5 9H13z"/></svg>

data/_includes/icon-github.html

@@ -0,0 +1 @@
+<a href="https://github.com/{{ include.username }}"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">{{ include.username }}</span></a>

data/_includes/icon-github.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 16 16" width="16px" height="16px"><path fill="#828282" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761 c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32 c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472 c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037 C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65 c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261 c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082 c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129 c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/></svg>

data/_includes/icon-keybase.html

@@ -0,0 +1 @@
+<a href="https://keybase.io/{{ include.username }}"><span class="icon icon--keybase">{% include icon-keybase.svg %}</span><span class="username">{{ include.username }}</span></a>

data/_includes/icon-keybase.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 24 24" width="16px" height="16px"><path fill="#828282" d="M12.65 10C11.83 7.67 9.61 6 7 6c-3.31 0-6 2.69-6 6s2.69 6 6 6c2.61 0 4.83-1.67 5.65-4H17v4h4v-4h2v-4H12.65zM7 14c-1.1 0-2-.9-2-2s.9-2 2-2 2 .9 2 2-.9 2-2 2z"/></svg>

data/_includes/icon-linkedin.html

@@ -0,0 +1 @@
+<a href="https://www.linkedin.com/in/{{ include.username }}"><span class="icon icon--linkedin">{% include icon-linkedin.svg %}</span><span class="username">{{ include.username }}</span></a>

data/_includes/icon-linkedin.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 24 24" width="16px" height="16px"><path fill="#828282" d="M19 0h-14c-2.761 0-5 2.239-5 5v14c0 2.761 2.239 5 5 5h14c2.762 0 5-2.239 5-5v-14c0-2.761-2.238-5-5-5zm-11 19h-3v-11h3v11zm-1.5-12.268c-.966 0-1.75-.79-1.75-1.764s.784-1.764 1.75-1.764 1.75.79 1.75 1.764-.783 1.764-1.75 1.764zm13.5 12.268h-3v-5.604c0-3.368-4-3.113-4 0v5.604h-3v-11h3v1.765c1.396-2.586 7-2.777 7 2.476v6.759z"/></svg>

data/_includes/icon-twitter.html

@@ -0,0 +1 @@
+<a href="https://twitter.com/{{ include.username }}"><span class="icon icon--twitter">{% include icon-twitter.svg %}</span><span class="username">{{ include.username }}</span></a>

data/_includes/icon-twitter.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 16 16" width="16px" height="16px"><path fill="#828282" d="M15.969,3.058c-0.586,0.26-1.217,0.436-1.878,0.515c0.675-0.405,1.194-1.045,1.438-1.809c-0.632,0.375-1.332,0.647-2.076,0.793c-0.596-0.636-1.446-1.033-2.387-1.033c-1.806,0-3.27,1.464-3.27,3.27 c0,0.256,0.029,0.506,0.085,0.745C5.163,5.404,2.753,4.102,1.14,2.124C0.859,2.607,0.698,3.168,0.698,3.767 c0,1.134,0.577,2.135,1.455,2.722C1.616,6.472,1.112,6.325,0.671,6.08c0,0.014,0,0.027,0,0.041c0,1.584,1.127,2.906,2.623,3.206 C3.02,9.402,2.731,9.442,2.433,9.442c-0.211,0-0.416-0.021-0.615-0.059c0.416,1.299,1.624,2.245,3.055,2.271 c-1.119,0.877-2.529,1.4-4.061,1.4c-0.264,0-0.524-0.015-0.78-0.046c1.447,0.928,3.166,1.469,5.013,1.469 c6.015,0,9.304-4.983,9.304-9.304c0-0.142-0.003-0.283-0.009-0.423C14.976,4.29,15.531,3.714,15.969,3.058z"/></svg>

data/_includes/icon-website.html

@@ -0,0 +1 @@
+<a href="{{ include.url }}"><span class="icon icon--website">{% include icon-website.svg %}</span><span class="username">{{ include.url | replace:'https://','' }}</span></a>