jekyll-theme-dml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab9e0d882fa6eb94431281033ba85281b3902c82
+  data.tar.gz: f3c983483e476b98ebd77ff3972f5220b80d1f91
+SHA512:
+  metadata.gz: 11add161c174405c131c8fd582f06191010259f5ff668983ecce8ee6717be309cdc5858404cc1f1ff4c96f45073aac68fdd5660cb6717320fe0d6c2125123fa2
+  data.tar.gz: 4079226a2520b146f71ef5fb420d990ff32f9644382a3600fd3b0e793458a39d784873e5727bbf36a1795c3cb67d54c7320107a435df1413f5bbed0c72e1ec03

data/404.md

@@ -0,0 +1,12 @@
+---
+layout: default
+permalink: /404.html
+---
+# Error 404
+Not found
+
+The page you are looking for was not found. Some possible reasons are:
+* you typed a wrong url
+* you clicked on a broken link
+
+[click here](/) to back to home page

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Parker Moore
+Copyright (c) 2017 Delson Lima
+
+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,133 @@
+# jekyll-theme-dml
+
+Welcome to jekyll-theme-dml!
+
+jekyll-theme-dml is a simple dark theme based on [minima](https://github.com/jekyll/minima) with easy multilingual setup
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-dml"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-dml
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-dml
+
+## Usage
+
+### Layouts
+
+Currently the following layouts are available: *authors*, *blog*, *default*, *home*, *lang_blog*, *lang_chooser*, *page*, *post* and *projects*:
+
+  - `authors` — automatically generates a list of site's authors using data from `_data/authors.yml`
+  - `default` — default layout used for every other layouts
+  Use this if you want to create a new custom layout placing it inside `_layouts` on your site's root directory
+  - `lang_chooser` — generates a page with all languages available and a link for each one
+  - `page` — the pages of your site
+  - `post` — the posts of your site
+  - `projects` — automatically generates a list of your projects using data from `_data/projects.yml`
+
+The layouts *blog*, *home* and *lang_blog* are almost alike, with a few differences between them:
+
+  - `blog`: use this anywhere you want to place your post list. e.g: `https://yourdomain/blog`
+  - `home`: this layout is the same as *blog*. If you want to show your post list at home page you may want to use it
+  - `lang_blog`: use this if you want to show only the posts on page language
+
+### Multilingual
+
+jekyll-theme-dml was designed to be multi multilingual!
+You can specify a language on every page. All you have to do is include a `lang` key on its front matter:
+
+```yaml
+---
+layout: post
+title: post_title
+lang: en
+---
+```
+
+The best way to organize your multi multilingual site is setting subfolders for every language. And also inside `_posts`.
+For example, a site with two languages: *english* and *portuguese*, should be as follows:
+
+```
+.
+├── en
+├── pt
+├── _posts
+|   └── en
+|   └── pt
+```
+
+Where folders `en` and `pt` contains the pages in each language.
+Example:
+
+```
+.
+├── en
+|   └── about.md
+├── pt
+|   └── about.md
+```
+
+Here there is a page called about on each folder.
+Where `https://example.com/en/about.html` will be the page in english, and `https://example.com/pt/about.html` will be the page in portuguese.
+You can also choose a localized name to your pages by change its filename:
+
+```
+.
+├── en
+|   └── about.md
+├── pt
+|   └── sobre.md
+```
+
+Then address will be `https://example.com/pt/sobre.html`
+
+### Choosing Defaults
+
+You can choose a default language (and everything else) for every path on your site. So you don't have to add `lang` key to every page or post.
+It can be done by adding a `defaults` key to your `_config.yml`:
+
+```yaml
+defaults:
+  - scope:
+      path: "en"
+    value:
+      lang: "en"
+  - scope:
+      path: "pt"
+    value:
+      lang: "pt"
+  - scope:
+      path: "_posts/en"
+    value:
+      lang: "en"
+  - scope:
+      path: "_posts/pt"
+    value:
+      lang: "pt"
+```
+
+For more info see [Jekyll docs](https://jekylllrb.com/docs/configuration/#front-matter-defaults)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/delsonlima/jekyll-theme-dml.
+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.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_data/authors.yml

@@ -0,0 +1,10 @@
+username:
+  name: Your Name
+  image:
+  # you can add description in multiple languages by adding a child to "description", with language code. e.g. "en"
+  description:
+    en: your description
+  links:
+    site: https://example.com
+    github: https://github.com/{username}
+    twitter: https://twitter.com/{username}

data/_data/config.yml

@@ -0,0 +1,10 @@
+# you can choose to use png images instead of svg.
+# tip: set it to true if want your site to be available to older browsers which doesn't support svg.
+#bitmap_mode: false
+#date_format:
+
+# here you can add more languages to your site by placing a child to "langs", with language code. e.g.: "pt".
+# you also need to specify its localized name. e.g.: "português" for "pt". ex:
+#langs:
+#  en: english
+#  pt: português

data/_data/localization.yml

@@ -0,0 +1,14 @@
+lang: en
+# you can choose a date format to whole site placing it as a string to "date_format". e.g.: "%b %d, %Y"
+# or choose a format for each language by placing a string to a child of "date_format", with language code. e.g.: "pt". As follows:
+#date_format:
+#  pt: "%d %b, %Y"
+
+# you can write a localized description by adding a string to a child of "description" object, with language code. e.g.: "pt". As follows:
+#description:
+#  pt: your localized description
+
+# here you can translate the site strings by placing a string to a child of "strings", with language code. e.g.: "pt". As follows:
+#strings:
+#  read_more:
+#    pt: "continuar lendo"

data/_data/projects.yml

@@ -0,0 +1,10 @@
+project:
+  name:
+  description:
+    en: "project details"
+    pt: "detalhes do projeto"
+  icon:
+  url: https://github.com/user/project
+  link:
+    en: /en/projects/project
+    pt: /pt/projetos/project

data/_includes/author.html

@@ -0,0 +1,23 @@
+{% assign default_author = site.data.config.default_author | default: site.theme_config.default_author %}
+{% assign github_username = site.github.owner_name %}
+{% assign author_name = include.author | default: default_author | default: github_username %}
+{% assign author = site.data.authors[author_name] %}
+{% assign author_link = author.links.first[1] %}
+
+{% if author_name %}
+  •
+  <span itemprop="author" itemscope itemtype="http://schema.org/Person">
+    <span itemprop="name">
+
+      {% if author %}
+        {% if author_link %}
+          <a href="{{ author_link }}" title="{{ author.name }}">{{ author.name }}</a>
+        {% else %}
+          {{ author.name }}
+        {% endif %}
+      {% else %}
+        {{ author_name | default: "unknown author" }}
+      {% endif %}
+    </span>
+  </span>
+{% endif %}

data/_includes/date.html

@@ -0,0 +1,11 @@
+{% assign date_config_lang = site.data.localization.date_format | default: site.data.config.date_format | default: site.theme_config.date_format %}
+{% assign default_lang = site.lang | default: "en" %}
+
+{% if date_config_lang.first %}
+  {% assign date_config = date_config_lang[page.lang] | default: date_config_lang[default_lang] %}
+{% else %}
+  {% assign date_config = date_config_lang %}
+{% endif %}
+
+{% assign date_format = date_config | default: "%b %-d, %Y" %}
+{{ include.date | date: date_format }}

data/_includes/disqus_comments.html

@@ -0,0 +1,23 @@
+{% if page.comments != false and jekyll.environment == "production" %}
+
+  <section class="comments">
+    <h2>{% include localized_string.html string="Comments" %}</h2>
+    <div id="disqus_thread"></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>
+  </section>
+{% endif %}

data/_includes/footer.html

@@ -0,0 +1,57 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+    <div class="footer-col-wrapper">
+      <div class="footer-col footer-col-1">
+        <ul class="contact-list">
+          <li>
+            {{ site.title | escape }}
+            </li>
+            {% assign email = site.email %}
+            {% if email %}
+              <li><a href="mailto:{{ site.email }}">{{ email }}</a></li>
+            {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-2">
+        <ul class="social-media-list">
+          {% if site.feed.path %}
+            <li>
+              {% include icon-feed.html %}
+            </li>
+          {% endif %}
+
+          {% assign github_username = site.data.config.github_username | default: site.github_username %}
+          {% if github_username %}
+            <li>
+              {% include icon-github.html username=github_username %}
+            </li>
+          {% endif %}
+
+          {% assign twitter_username = site.data.config.twitter_username | default: site.twitter_username %}
+          {% if twitter_username %}
+            <li>
+              {% include icon-twitter.html username=twitter_username %}
+            </li>
+          {% endif %}
+
+          {% assign facebook_username = site.data.config.facebook_username | default: site.facebook_username %}
+          {% if facebook_username %}
+            <li>
+              {% include icon-facebook.html username=facebook_username %}
+            </li>
+          {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-3">
+        {% assign localized_description = site.data.localization.description[page.lang] %}
+        {% assign description = localized_description | default: site.description %}
+        <p>{{ description | escape }}</p>
+      </div>
+    </div>
+
+  </div>
+
+</footer>

data/_includes/google-analytics.html

@@ -0,0 +1,9 @@
+<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','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+</script>

data/_includes/head.html

@@ -0,0 +1,23 @@
+<head>
+  <meta charset="{{ site.encoding }}">
+  <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 }}">
+
+  {% assign icon = site.data.config.icon | default: site.theme_config.icon %}
+  {% if icon != "" %}
+    <link rel="icon" type="image/x-icon" href="{{ icon }}">
+  {% endif %}
+
+  {% if site.feed.path %}
+    <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ site.feed.path | relative_url }}">
+  {% endif %}
+
+  {% if jekyll.environment == 'production' and site.google_analytics %}
+    {% include google-analytics.html %}
+  {% endif %}
+</head>

data/_includes/header.html

@@ -0,0 +1,38 @@
+<header class="site-header" role="banner">
+
+  <div class="wrapper">
+    {% assign default_paths = site.pages | map: "path" %}
+    {% assign page_paths = site.header_pages | default: default_paths %}
+    <a class="site-title" href="{{ '/' | relative_url }}">{{ site.title | escape }}</a>
+
+    {% if page_paths %}
+      <nav class="site-nav">
+        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+        <label for="nav-trigger">
+          <span class="menu-icon">
+            {% assign bitmap_mode = site.data.config.bitmap_mode | default: site.theme_config.bitmap_mode %}
+            {% if bitmap_mode == true %}
+              <img src="/assets/icons/icon-menu.png" />
+            {% else %}
+              {% include icon-menu.svg %}
+            {% endif %}
+          </span>
+        </label>
+
+        <div class="trigger">
+          {% assign home_link = page.home_link | default: site.data.config.home_link | default: site.theme_config.home_link %}
+          {% if home_link %}
+            <a class="page-link" href="/">Home</a>
+          {% endif %}
+
+          {% for path in page_paths %}
+            {% assign my_page = site.pages | where: "path", path | where: "lang", page.lang | first %}
+            {% if my_page.title %}
+              <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            {% endif %}
+          {% endfor %}
+        </div>
+      </nav>
+    {% endif %}
+  </div>
+</header>

data/_includes/icon-facebook.html

@@ -0,0 +1,11 @@
+{% assign bitmap_mode = site.data.config.bitmap_mode | default: site.theme_config.bitmap_mode %}
+<a href="https://facebook.com/{{ include.username }}">
+  <span class="icon icon--facebook">
+    {% if bitmap_mode == true %}
+      <img src="/assets/icons/icon-facebook.png"/>
+    {% else %}
+      {% include icon-facebook.svg %}
+    {% endif %}
+  </span>
+  <span class="username">{{ include.username }}</span>
+</a>

data/_includes/icon-facebook.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 16 16" width="16px" height="16px"><path fill="#828282" d="m 16,1 0,14 c 0,0.542857 -0.457143,1 -1,1 l -4,0 0,-6.228571 2,0 0.342857,-2.314286 -2.342857,0 0,-1.8 C 11,5 11.342857,4.628571 12,4.628571 l 1.485714,0 0,-2.085714 c 0,0 -0.685714,-0.114286 -1.628571,-0.114286 -2.2000001,0 -3.3142859,1.228572 -3.3142859,3.028572 l 0,2 -2,0 0,2.314286 2,0 0,6.228571 L 1,16 C 0.45714286,16 0,15.542857 0,15 L 0,1 C 0,0.457143 0.45714286,0 1,0 l 14,0 c 0.542857,0 1,0.457143 1,1 z"/></svg>

data/_includes/icon-feed.html

@@ -0,0 +1,11 @@
+{% assign bitmap_mode = site.data.config.bitmap_mode | default: site.theme_config.bitmap_mode %}
+<a href="{{ site.feed.path | default: '/feed.xml' | relative_url }}">
+  <span class="icon icon--feed">
+    {% if bitmap_mode == true %}
+      <img src="/assets/icons/icon-feed.png"/>
+    {% else %}
+      {% include icon-feed.svg %}
+    {% endif %}
+  </span>
+  <span>feed</span>
+</a>