jekyll-theme-open-project 0.1.6 → 1.0.0.pre.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1455bc3d106d07589f676621e160bcc927f21723
-  data.tar.gz: 7ed324c9a0be2aecd73a1cfffd5e057ce76a5e32
+  metadata.gz: 5e3183b2c8b57bd349b4bf52814e6f82235e3ca6
+  data.tar.gz: 77fc79ad0e9588e6407d121c4abf0960d4be7e75
 SHA512:
-  metadata.gz: 951495b57e7b5a4b1b068258e2d7ff744dfa80d570b704696c33d2d10b3fbe464f67a31acc8bd628d95e6369837af06392c3fe422af9867c8a31a6a750ae6895
-  data.tar.gz: 2e0f09342c69b7b629d4991871acf1b8f7298ae3d524d89e30ad86510e5064d40d4e64d182e61b4c7917af5dbf994daeb763b62caa87bd920889d473db25c135
+  metadata.gz: 1ea724c553743a8010118d1fb548a117a817af5a1a1dd29728938300eeb76c4a383eca37580426a334e3174cf55a814ed170032e93ff65441a681f9638431e3c
+  data.tar.gz: 3f662fd2af364a8548ce72ffde2f100fd57a5f24030a1a766377353a4224130aaab62be803933ca5098b0c738384146a619cc41eb4ef7fd7e60170935ebcd0a0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Anton Strogonoff
+Copyright (c) 2018 Ribose
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -51,14 +51,18 @@ replacing default theme requirement:
 gem 'jekyll-theme-open-project'
 ```
 
-Add this line to your Jekyll site's `_config.yml`,
-replacing default theme requirement:
+(Jekyll’s default theme was “minima” at the time of this writing.)
 
-```yaml
-theme: jekyll-theme-open-project
-```
+Also in the `Gemfile`, add two important plugins to the `:jekyll_plugins` group.
+(The SEO tag plugin is not mandatory, but these docs assume you use it.)
 
-(Jekyll’s default theme was “minima” at the time of this writing.)
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-seo-tag"
+  gem "jekyll-theme-open-project-helpers"
+  # ...other plugins, if you use any
+end
+```
 
 Execute to install dependencies:
 
@@ -85,11 +89,12 @@ and it’ll use localhost.
 
 ## Universal setup
 
-These are applicable to both site types (hub and project).
+These settings are required to both site types (hub and project).
 
 - You may want to remove the default about.md page added by Jekyll,
   as this theme does not account for its existence.
-- Add following items to _config.yml:
+- Add following items to _config.yml
+  (don’t forget to remove default theme requirement):
 
   ```yaml
   title: Site title
@@ -97,6 +102,22 @@ These are applicable to both site types (hub and project).
   # The above two are used by jekyll-seo-tag for things such as
   # `<title>` and `<meta>` tags, as well as elsewhere by the theme.
 
+  tagline: Site tagline
+  pitch: Site pitch
+  # The above two are used on home hero unit.
+
+
+  # Further settings are not expected to be changed,
+  # unless you know what you’re doing:
+
+  markdown: kramdown
+  theme: jekyll-theme-open-project
+
+  # Theme layouts can include from any directory, not just _includes.
+  # There’s a quirk in Jekyll’s “safe” behavior around include and gem-based themes
+  # which means include_relative wouldn’t cut it.
+  includes_dir: .
+
   collections:
     posts:
       output: true
@@ -115,9 +136,6 @@ These are applicable to both site types (hub and project).
         type: posts
       values:
         layout: post
-
-  plugins:
-    - jekyll-seo-tag
   ```
 
 ### Logo
@@ -153,6 +171,9 @@ You may want to supply _includes/legal.html with content like this:
 
 Project sites and hub site can have a blog.
 
+In case of the hub, blog index will show combined timeline
+from hub blog and projects’ blogs.
+
 #### Index
 
 Create blog index page as _pages/blog.html, with nothing but frontmatter.
@@ -174,8 +195,26 @@ hero_include: index-page-hero.html
 
 #### Posts
 
-Place posts under _posts and name files e.g.
-`2018-04-20-welcome-to-jekyll.markdown`. This is typical Jekyll setup.
+In general, posts are authored as per usual Jekyll setup.
+
+The following _additional_ data is expected within post document frontmatter:
+
+```yaml
+---
+author:
+  email: <author’s email>
+  name: <author’s full name>
+  social_links:
+    - https://twitter.com/username
+    - https://facebook.com/username
+    - https://linkedin.com/in/username
+---
+```
+
+For hub-wide posts, put posts under _posts/ in site root and name files e.g.
+`2018-04-20-welcome-to-jekyll.markdown` (no change from the usual Jekyll setup).
+
+For project posts, see below about shared project data structure.
 
 
 ## Hub site
@@ -221,6 +260,23 @@ featured: true | false
 home_url: <URL to standalone project site>
 ```
 
+### Project index page
+
+Create software index in _pages/projects.html, with nothing but frontmatter.
+Use layout called "project-index", pass `hero_include: index-page-hero.html`,
+and set `title` and `description` as appropriate.
+
+Example:
+
+```yaml
+---
+title: Open projects
+description: Projecting goodness into the world!
+layout: project-index
+hero_include: index-page-hero.html
+---
+```
+
 ### Software index page
 
 Create software index in _pages/software.html, with nothing but frontmatter.
@@ -294,7 +350,7 @@ defaults:
 ```
 
 File layout is the same as described in the section
-about shared project data structure, with _software and _specs directories
+about shared project data structure, with _software, _specs, _posts directories
 found in the root of your Jekyll site.
 
 
@@ -307,13 +363,26 @@ Following data structure is shared and used to describe projects,
 whether on hub home site or each individual project site:
 
     - <project-name>/
+      - _posts/
+        - 2038-02-31-blog-post-title.markdown
       - _includes/
         - symbol.svg
       - _software/
-        - <name>.md
+        - <name>/
+          - symbol.svg
+          - index.md
+          - _docs/
+            - <version>/
+              - overview.md
+              - <documentation-page-name>.md
       - _specs/
         - <name>.md
 
+### Blog
+
+Project blog posts should be authored as described in the universal setup
+section.
+
 ### Software and specs
 
 An open project serves as an umbrella for related
@@ -421,6 +490,10 @@ Commonly used layouts are:
 
 - post: Blog post
 
+- project-index: Open project index page (hub site only).
+  Suggested to supply hero_include.
+  Will show a list of open projects across the hub.
+
 - software-index: Software index page (hub site only).
   Suggested to supply hero_include.
   Will show a list of software across projects within the hub.
@@ -456,8 +529,10 @@ under assets/css/style.scss with following exact contents:
 @import '{{ site.theme }}';
 ```
 
-You can define custom style rules after the import, and customize variables
-before the import.
+There are two aspects to theme customization:
+
+* Cutomize SASS variables before the import (such as colors)
+* Define custom style rules after the import
 
 ### Custom rules
 
@@ -494,6 +569,15 @@ $accent-color: red !default;
 # hero unit respectively. Gradients can be supplied.
 $header-background: $primary-dark-color !default;
 $hero-background: $primary-dark-color !default;
+
+# Below customize colors for different sections of the site.
+$hub-software--primary-color: lightsalmon !default;
+$hub-software--primary-dark-color: tomato !default;
+$hub-software--hero-background: $hub-software--primary-dark-color !default;
+
+$hub-specs--primary-color: lightpink !default;
+$hub-specs--primary-dark-color: palevioletred !default;
+$hub-specs--hero-background: $hub-specs--primary-dark-color !default;
 ```
 
 

data/_includes/home-hero.html

@@ -1,2 +1,15 @@
-<h1>{{ site.title }}</h1>
-<p class="desc">{{ site.description }}</p>
+<div role="presentation" class="text">
+  <h1 class="title">{{ site.tagline }}</h1>
+  <p class="desc">{{ site.pitch | safe }}</p>
+  <div class="cta explore-projects" role="presentation">
+    <a class="button" href="{{ "/projects/" | relative_url }}">
+      <i class="icon far fa-search"></i>
+      Explore Projects
+    </a>
+  </div>
+</div>
+<div role="presentation" class="illustration">
+  <div role="presentation" class="logo">
+    {% include symbol-hero.svg %}
+  </div>
+</div>

data/_includes/home-hub.html

@@ -1,59 +1,91 @@
-{% assign featured_projects = site.projects | where: "featured", true %}
-{% assign num_featured_projects = featured_projects | size %}
-{% if num_featured_projects > 0 %}
-  <section class="featured-projects">
-    <h2 class="title">Featured Projects</h2>
+{% assign projects = site.projects | where_exp: "item", "item.home_url != nil" %}
 
-    <div class="items" role="presentation">
+<div class="underlay top-background" role="presentation">
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none">
+    <polygon fill="white" points="0,0 100,0 100,60 0,100"/>
+  </svg>
 
-      {% for item in featured_projects limit:3 %}
-        {% assign symbol_path = item.path | split: "/" | slice: 0, 2 | join: "/" | append: "/_includes/symbol.svg" %}
-        {% assign relative_symbol_path = "/" | append: symbol_path %}
+  {% assign featured_projects = projects | where: "featured", true %}
+  {% assign num_featured_projects = featured_projects | size %}
+  {% if num_featured_projects > 0 %}
+    <section class="featured-projects">
+      <h2 class="title">Featured Projects</h2>
 
-        <a class="item" href="{{ item.home_url }}" role="article">
-          <div class="logo-container" role="presentation">
-            <div class="logo">{% include_relative {{ relative_symbol_path }} %}</div>
-          </div>
-          <h3 class="header">{{ item.title }}</h3>
-          <p class="body">
-            {{ item.description }}
-          </p>
-        </a>
-      {% endfor %}
-    </div>
-  </section>
-{% endif %}
+      <div class="items" role="presentation">
 
-{% assign num_featured_posts = site.posts | size %}
-{% if num_featured_posts > 0 %}
-  <section class="featured-posts">
-    <div role="presentation" class="puny-label">Latest news</div>
-    <h2 class="title">From the Blog</h2>
-
-    <div class="items" role="presentation">
-      {% for item in site.posts limit:3 %}
-        <a class="item" href="{{ item.url }}" role="article">
-          {% include post-card.html %}
-        </a>
-      {% endfor %}
-    </div>
-  </section>
-{% endif %}
+        {% for item in featured_projects limit:3 %}
+          {% assign symbol_path = item.path | split: "/" | slice: 0, 2 | join: "/" | append: "/_includes/symbol.svg" %}
+          {% assign relative_symbol_path = "/" | append: symbol_path %}
+
+          <a class="item" href="{{ item.home_url }}" role="article">
+            <header>
+              <div class="logo-container" role="presentation">
+                <div class="logo">{% include {{ relative_symbol_path }} %}</div>
+              </div>
+              <h3 class="title">{{ item.title }}</h3>
+            </header>
+
+            <p class="body">
+              {{ item.description }}
+            </p>
+
+            <div class="cta-view-project">
+              <div class="button">View Project</div>
+            </div>
+          </a>
+        {% endfor %}
+      </div>
+    </section>
+  {% endif %}
 
-{% assign other_projects = site.projects | where: "featured", false %}
+  {% assign num_featured_posts = site.posts | size %}
+  {% if num_featured_posts > 0 %}
+    <section class="featured-posts">
+      <div role="presentation" class="puny-label">Latest news</div>
+      <h2 class="title">From the Blog</h2>
+
+      <div class="items" role="presentation">
+        {% for item in site.posts limit:3 %}
+          {% include post-card.html post=item %}
+        {% endfor %}
+      </div>
+    </section>
+  {% endif %}
+</div>
+
+{% assign other_projects = projects | where: "featured", true %}
 {% assign num_other_projects = other_projects | size %}
 {% if num_other_projects > 0 %}
 <section class="other-projects">
+  {% include symbol.svg %}
+
   <h2 class="title">Other Projects</h2>
 
   <div class="items {% if num_other_projects < 5 %}one-row{% endif %}"
       role="presentation">
     {% for item in other_projects %}
       <a class="item" href="{{ item.home_url }}" role="article">
-        <h3 class="header">{{ item.title }}</h3>
+        <header>
+          <div class="logo-container" role="presentation">
+            <div class="logo">{% include {{ relative_symbol_path }} %}</div>
+          </div>
+          <h3 class="title">{{ item.title }}</h3>
+        </header>
+
         <p class="body">
           {{ item.description }}
         </p>
+
+        {% assign num_tags = item.tags | size %}
+        {% if num_tags > 0 %}
+          <footer class="meta">
+            <ul class="tags">
+              {% for tag in item.tags %}
+                <li>{{ tag }}</li>
+              {% endfor %}
+            </ul>
+          </footer>
+        {% endif %}
       </a>
     {% endfor %}
   </div>

data/_includes/home-project.html

@@ -47,9 +47,7 @@
 
     <div class="items" role="presentation">
       {% for item in site.posts %}
-        <a class="item" href="{{ item.url }}" role="article">
-          {% include post-card.html %}
-        </a>
+        {% include post-card.html post=item %}
       {% endfor %}
     </div>
   </section>

data/_includes/index-page-hero.html

@@ -1,2 +1,4 @@
-<h1>{{ page.title }}</h1>
-<p class="desc">{{ page.description }}</p>
+<div role="presentation" class="text">
+  <h1 class="title">{{ page.title }}</h1>
+  <p class="desc">{{ page.description }}</p>
+</div>

data/_includes/index-page-item-filter.html

@@ -0,0 +1,28 @@
+{% capture rawtags %}{% for doc in include.items %}{% for tag in doc.tags %}{{ tag }} {% endfor %}{% endfor %}{% endcapture %}
+
+{% assign tags = rawtags | split: " " | uniq %}
+{% assign num_tags = tags | size %}
+
+{% if num_tags > 0 %}
+  <nav class="item-filter">
+    <ul class="tags">
+      <li>
+        {% if include.tag %}
+          <a href="{{ include.url_tag_prefix }}">All</a>
+        {% else %}
+          <span>All</span>
+        {% endif %}
+      </li>
+
+      {% for tag in tags %}
+      <li>
+        {% if tag == include.tag %}
+          <span>{{ tag }}</span>
+        {% else %}
+          <a href="{{ include.url_tag_prefix }}{{ tag }}">{{ tag }}</a>
+        {% endif %}
+      </li>
+      {% endfor %}
+    </ul>
+  </nav>
+{% endif %}

data/_includes/nav-page-link.html

@@ -1,5 +1,16 @@
-{% if page.url == include.url %}
+{% if include.active_for_nested %}
+  {% assign first_component = page.url | split: '/' | slice: 0, 2 | join: '/' | append: '/' %}
+  {% if first_component == include.url %}
+    {% assign active_nested = true %}
+  {% else %}
+    {% assign active_nested = false %}
+  {% endif %}
+{% endif %}
+
+{% if active_nested or page.url == include.url %}
   <span>{{ include.title }}</span>
 {% else %}
   <a href="{{ include.url }}">{{ include.title }}</a>
 {% endif %}
+
+{% assign active_nested = false %}