jekyll-oceanic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7560ddef689732ed2d2981f02347dee48d3dfa33221c52156fad5d6a6f06ef5
+  data.tar.gz: f5950e59454449092f7a486cbc6ff93ccf83b98bb3dcc1fd29079024d8b8e0f4
+SHA512:
+  metadata.gz: b5e8034bcc70e76300734055224050a594796530e2104cbcf96b31d9714aa73698c938e11e8aabeb113584149e4ed38688fa3564f1f788d7a55dceefc3568ed0
+  data.tar.gz: c096fd8f9d30f1013099a16b3e3dfb33493c2081988593ed7418e3daa0081433ddaea122baa88537a164daeb5f24cb780f646584f02fe64dc48bfc7d7666acb3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Karl Nicoll
+
+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,96 @@
+# Oceanic - A Minimalist, Blue Theme For Jekyll
+
+Oceanic is intended as a simple theme for Jekyll websites, with a main focus
+on blogs.
+
+## Features
+
+* Bright and minimalist theme.
+* Skinning options with custom SASS parameters to tweak colours, fonts and some
+  sizes.
+* Code syntax highlighting through Rouge support. Syntax highlighting can also
+  be skinned with custom colours if preferred.
+* Configuration is easy to customize to specify:
+
+  * Specify avatar image
+  * Social media links
+  * Theme skin
+  * Pagination options
+  * Category/Tag options
+  * and more...
+
+## Screenshots
+
+See [HERE](SCREENSHOTS.md)
+
+## Usage
+
+### Step 1: Installation
+
+First, add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-oceanic"
+```
+
+Next, add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-oceanic
+```
+
+Finally, execute:
+
+```shell
+$ bundle config set path .bundle
+$ bundle install
+...
+```
+
+or install it system-wide with:
+
+```shell
+$ gem install jekyll-oceanic
+...
+```
+
+### Step 2: Configuration
+
+Once installed, the theme should run out of the box with no configuration
+required. However, you will want to customize in order to set up your website
+the way you want.
+
+See [HERE](CONFIGURATION.md) for a rundown of the various configuration
+options.
+
+## Customization
+
+The theme can be easily customized by creating *skins*. Skins are
+[Sass](https://sass-lang.com/) files that define colors, fonts, and various
+other style properties that can be adjusted.
+
+See HERE for a brief introduction to skinning.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/karlnicoll/jekyll-oceanic. 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
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run
+`bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
+This starts a Jekyll server using your theme. Add pages, documents, data, etc.
+like normal to test your theme's contents. As you make modifications to your
+theme and to your content, your site will regenerate and you should see the
+changes in the browser after a refresh, just like normal.
+
+## License
+
+The theme is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1,106 @@
+# Theme. Always "jekyll-oceanic" if using this theme.
+theme: jekyll-oceanic
+
+# Your name (or the company name for a company site). This is displayed
+# in the header.
+author:
+  name: "Oceanic"
+
+# A description of you, or of the site. This is displayed in the header.
+description: A minimalist, blue, Jekyll theme.
+
+# Show the first openings of posts when listing. Set to false to just
+# display titles and dates.
+show_excerpts: true
+
+# Custom theme settings. Specify the specific skin or syntax
+# highlighting here.
+oceanic:
+  skin: default
+  code-skin: default
+
+  # If you wish to have a photo or logo in the header, specify the
+  # following values:
+  #
+  # * url - the url (or local path) of the image to use as the avatar
+  #         (default: no avatar).
+  # * width - the width of the image (default: 100px).
+  # * height - the height of the image (default: 100px).
+  #
+  avatar:
+    url: "/assets/img/avatar.jpg"
+    width: "100px"
+    height: "100px"
+
+  # Social media links. If the link is specified, an icon is shown in the
+  # header as a link.
+  social:
+    facebook: https://www.facebook.com/jekyll.user
+    github: https://www.github.com/jekyll.user
+    linkedin: https://www.linkedin.com/in/jekylluser
+    stackoverflow: https://stackoverflow.com/users/00000/stack-user
+    steam: https://steamcommunity.com/id/jekylluser/
+    twitter: https://www.twitter.com/jekylluser
+
+  # If specified, sets the number of blog entries to display from the
+  # homepage. More blog entries can be found by navigating to a
+  # separate post list.
+  homepage_blog_entries: 5
+
+# Pagination settings. The Oceanic template uses jekyll-paginate-v2 to
+# allow pagination of posts.
+pagination:
+  enabled: true
+  debug: false
+  collection: posts
+  per_page: 1
+  permalink: "/page:num/"
+  title: ':title'
+  limit: 0
+  sort_field: date
+  sort_reverse: true
+  category: posts
+  tag: ''
+  locale: ''
+
+# The Oceanic template provides layout support for the jekyll-archives
+# plugin. If you are using it, it can be configured here.
+autopages:
+  enabled: true
+
+  categories:
+    enabled: true
+    layouts:
+      - 'autopage.html'
+    title: 'Posts in category :cat'
+
+  tags:
+    enabled: false
+    layouts:
+      - 'autopage.html'
+
+  collections:
+    enabled: false
+
+# Specify the code highlighter. Oceanic is tested against the Rouge
+# syntax highlighter.
+highlighter: rouge
+
+# The Oceanic template provides layout support for the jekyll-archives
+# plugin. If you are using it, it can be configured here.
+# jekyll-archives:
+#   enabled:
+#     - categories
+#     - tags
+#   layout: archive
+#   permalinks:
+#     year: '/:year/'
+#     month: '/:year/:month/'
+#     day: '/:year/:month/:day/'
+#     tag: '/tag/:name/'
+#     category: '/category/:name/'
+
+plugins:
+  - jekyll-feed
+  - jekyll-paginate-v2
+  - jekyll-seo-tag

data/_includes/bloglist.html

@@ -0,0 +1,68 @@
+{%- if include.postlist.size > 0 and include.postlist.size -%}
+  {%- assign date_format = site.date_format | default: "%b %-d, %Y" -%}
+  <ol class="blog-entries">
+    {%- for post in include.postlist -%}
+      <li role="article">
+        <h3><a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a></h3>
+        <aside>Published: {{ post.date | date: date_format }}</aside>
+        {{ post.excerpt }}
+        <a href="{{ post.url | relative_url }}">Continue reading...</a></h3>
+      </li>
+    {%- endfor -%}
+  </ol>
+
+  {% if include.paginator and include.paginator.total_pages > 1 %}
+    {%- if page.pagination.permalink -%}
+      {% assign page_permalink = page.pagination.permalink %}
+    {%- else -%}
+      {% assign page_permalink = site.pagination.permalink %}
+    {%- endif -%}
+    {%- comment -%}
+    #
+    # HACK: We need the paginator's base directory in order to provide
+    # page direct links. Unfortunately, there is no particularly easy
+    # way of working out the directory from the include.paginator. For example,
+    # `page.dir` could return '/blog/page2/' on the second paginator
+    # page, which is not the desired directory (we'd actually want
+    # '/blog/'). So generate here using a bit of a hack.
+    #
+    # * On the first page, generation from page.dir is valid.
+    # * On subsequent pages, work out the page-y portion of the URL and
+    #   replace it.
+    #
+    {%- endcomment -%}
+    {%- if 1 == include.paginator.page -%}
+      {%- assign page_path_format = page.dir | append: page_permalink | replace: "//", "/" -%}
+    {%- else -%}
+      {%- assign current_page_subdirectory = page_permalink | replace: ':num', include.paginator.page -%}
+      {%- assign page_path_format = page.dir | remove_first: current_page_subdirectory | append: page_permalink -%}
+    {%- endif -%}
+    <ul class="pages">
+      {%- if include.paginator.previous_page -%}
+        <li><a title="Go to last page" href="{{ include.paginator.first_page_path | relative_url }}">&laquo;</a></li>
+        <li><a title="Go to previous page" href="{{ include.paginator.previous_page_path | relative_url }}">&lsaquo;</a></li>
+      {%- else -%}
+      <li><span title="Go to previous page">&laquo;</span></li>
+      <li><span title="Go to first page">&lsaquo;</span></li>
+      {%- endif -%}
+      {%- for page_number in (1..include.paginator.total_pages) -%}
+        {%- if page_number == include.paginator.page -%}
+          <li><a title="Refresh this page" href="{{ include.paginator.current_page_path }}">&#x25C9;</a></li>
+        {%- elsif page_number == 1 -%}
+          <li><a title="Go to page 1" href="{{ include.paginator.first_page_path | relative_url }}">&#x025CB;</a></li>
+        {%- else -%}
+          <li><a title="Go to page {{page_number}}" href="{{ page_path_format | relative_url | replace: ':num', page_number }}">&#x025CB;</a></li>
+        {%- endif -%}
+      {%- endfor -%}
+
+      {%- if include.paginator.next_page -%}
+        <li><a title="Go to next page" href="{{ include.paginator.next_page_path | relative_url }}">&rsaquo;</a></li>
+        <li><a title="Go to last page" href="{{ include.paginator.last_page_path | relative_url }}">&raquo;</a></li>
+      {%- else -%}
+        <li><span title="Go to next page">&rsaquo;</span></li>
+        <li><span title="Go to last page">&raquo;</span></li>
+      {%- endif -%}
+    </ul>
+  {%- endif %}
+
+{%- endif -%}

data/_includes/footer.html

@@ -0,0 +1,3 @@
+<footer>
+  ~~ Bottom of Page ~~
+</footer>

data/_includes/head.html

@@ -0,0 +1,6 @@
+<title>{{site.author.name}}{% if page.title and page.url != "/" and page.url != "/index.html" %} | {{page.title}}{% endif %}</title>
+<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+<link rel="shortcut icon" type="image/png" href="{{ "/assets/img/favicon.png" | relative_url }}">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta charset="UTF-8">
+{% seo title=false %}

data/_includes/header.html

@@ -0,0 +1,66 @@
+<header>
+  <div class="profile-area">
+    {% if site.oceanic.avatar-url != blank %}
+      <div class="avatar-wrap"><div class="avatar"></div></div>
+    {% endif %}
+    <div class="header-text-wrap">
+      <div class="header-text">
+        <h1>{{ site.author.name }}</h1>
+        <h2>{{ site.description }}</h2>
+      </div>
+    </div>
+  </div>
+
+  <input type="checkbox" id="oceanic-theme-display-nav" />
+  <label for="oceanic-theme-display-nav" style="width:100%;">
+    <svg viewBox="0 0 750 260">
+      <use xlink:href="{{ '/assets/img/icons.svg#menu' | relative_url }}"></use>
+    </svg>
+  </label>
+
+  <nav>
+    {%- assign pages = site.pages | where_exp: "item", "item.nav and item.nav.enabled and item.title and item.autogen == nil" | sort "title", "last" -%}
+    <ul>
+      {%- assign: index_page_url = "/" | relative_url -%}
+      <li{% if page.url == "/" %} class="current"{% endif %}><a href="{{ "/" | relative_url }}">Home</a></li>
+      {%- for my_page in pages -%}
+        {%- if my_page.title and "/" != my_page.url -%}
+          {%- if page.url == my_page.url -%}
+             <li class="current">
+          {%- elsif my_page.pagegroup -%}
+            {%- if page.pagegroup -%}
+              {%- if page.pagegroup == my_page.pagegroup -%}
+                <li class="current">
+              {%- else -%}
+                <li>
+              {%- endif -%}
+            {%- elsif layout.pagegroup -%}
+              {%- if layout.pagegroup == my_page.pagegroup -%}
+                <li class="current">
+              {% else %}
+                <li>
+              {% endif %}
+            {% else %}
+              <li>
+            {% endif %}
+          {% else %}
+              <li>
+          {% endif %}
+            <a href="{{ my_page.url | relative_url }}"> {{ my_page.title | escape }}</a>
+          </li>
+        {%- endif -%}
+      {%- endfor -%}
+    </ul>
+  </nav>
+
+  <div class="social-icons">
+    <ul>
+      {%- if site.oceanic.social.facebook -%}<li><a rel="me" href="{{ site.oceanic.social.facebook }}" title="{{ site.author.name | append: " at Facebook" }}"><svg viewBox="0 0 24 24"><use xlink:href="{{ '/assets/img/icons.svg#facebook' | relative_url }}"></use></svg></a></li>{%- endif -%}
+      {%- if site.oceanic.social.twitter -%}<li><a rel="me" href="{{ site.oceanic.social.twitter }}" title="{{ site.author.name | append: " at Twitter" }}"><svg viewBox="0 0 24 24"><use xlink:href="{{ '/assets/img/icons.svg#twitter' | relative_url }}"></use></svg></a></li>{%- endif -%}
+      {%- if site.oceanic.social.linkedin -%}<li><a rel="me" href="{{ site.oceanic.social.linkedin }}" title="{{ site.author.name | append: " at LinkedIn" }}"><svg viewBox="0 0 24 24"><use xlink:href="{{ '/assets/img/icons.svg#linkedin' | relative_url }}"></use></svg></a></li>{%- endif -%}
+      {%- if site.oceanic.social.stackoverflow -%}<li><a rel="me" href="{{ site.oceanic.social.stackoverflow }}" title="{{ site.author.name | append: " at StackOverflow" }}"><svg viewBox="0 0 24 24"><use xlink:href="{{ '/assets/img/icons.svg#stackoverflow' | relative_url }}"></use></svg></a></li>{%- endif -%}
+      {%- if site.oceanic.social.github -%}<li><a rel="me" href="{{ site.oceanic.social.github }}" title="{{ site.author.name | append: " at Github" }}"><svg viewBox="0 0 24 24"><use xlink:href="{{ '/assets/img/icons.svg#github' | relative_url }}"></use></svg></a></li>{%- endif -%}
+      {%- if site.oceanic.social.steam -%}<li><a rel="me" href="{{ site.oceanic.social.steam }}" title="{{ site.author.name | append: " at Steam" }}"><svg viewBox="0 0 24 24"><use xlink:href="{{ '/assets/img/icons.svg#steam' | relative_url }}"></use></svg></a></li>{%- endif -%}
+    </ul>
+  </div>
+</header>

data/_includes/liquid/data

@@ -0,0 +1 @@
+{% assign error_page = "/404.html" %}

data/_layouts/archive.html

@@ -0,0 +1,9 @@
+---
+layout: default
+pagegroup: __blog
+---
+
+<h1>Archive of posts with {{ page.type }} '{{ page.title }}'</h1>
+
+{%- assign postlist = page.posts | sort: "date" -%}
+{% include bloglist.html postlist=postlist %}

data/_layouts/autopage.html

@@ -0,0 +1,10 @@
+---
+layout: default
+pagegroup: __blog
+pagination:
+  sort_reverse: false
+---
+
+<h1>{{ page.title }}</h1>
+
+{% include bloglist.html postlist=paginator.posts paginator=paginator %}

data/_layouts/bloglist.html

@@ -0,0 +1,17 @@
+---
+layout: default
+---
+
+<h1>{{page.title}}</h1>
+
+{{ content }}
+
+{% if page.pagination.enabled %}
+  {% assign posts = paginator.posts %}
+  {% assign my_paginator = paginator %}
+{% else %}
+  {% assign posts = site.posts %}
+  {% assign my_paginator = nil %}
+{% endif %}
+
+{% include bloglist.html postlist=posts paginator=my_paginator %}

data/_layouts/categories.html

@@ -0,0 +1,35 @@
+---
+layout: default
+---
+
+<h1>{{page.title}}</h1>
+
+{{content}}
+
+{%- comment -%}
+#
+# The code below detects if jekyll-archives is being used, or if
+# the "autopages" feature of jekyll-paginate-v2 is being used.
+#
+{%- endcomment -%}
+{%- if site.jekyll-archives.enabled contains "categories" -%}
+  {%- assign permalink_stub = site.jekyll-archives.permalinks["category"] -%}
+  {%- assign cat_name_placeholder = ":name" -%}
+{%- elsif site.autopages.enabled and site.autopages.categories -%}
+  {%- assign permalink_stub = site.autopages.categories.permalink | default: '/category/:cat/' -%}
+  {%- assign cat_name_placeholder = ":cat" -%}
+{%- else -%}
+  <aside>Error: Unable to detect category index plugin.</aside>
+{%- endif -%}
+
+<h2>Available Categories:</h2>
+
+<ul class="cat-tag-col-list">
+  {% for category in site.categories %}
+    <li>
+      <a href={{ permalink_stub | replace: cat_name_placeholder, category[0] | relative_url }}>
+        {{ category[0] }}
+      </a>
+    </li>
+  {% endfor %}
+</ul>