jekyll-theme-open-project 1.3.4 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b4dcd33aba82235dfb9006a73ec08312b707d24b8aaf02004a48d9c8f9a39b60
-  data.tar.gz: c0e916d4e6898e541b438619c974d1e70c1e884cb0a89cbdaea0328f6e97b9ed
+SHA1:
+  metadata.gz: 221eba4af24be71eba3079f5413049ed6cbcd524
+  data.tar.gz: b487631fd4ccba5cf8aad76f9a22f95f6c0ec08d
 SHA512:
-  metadata.gz: b0870bba7d5b1229926777e61c1d0016743981aef0710d8a524137847250a4debfa77cbcea5462df809ef19dba9dada90df9304f13d4d8ae701713247f6e7289
-  data.tar.gz: 3cc202cc0740c816bb587f00b21a66738f925c13c14c8faecb8201780e10abd333e9e410e6610327b4536de8c16afb42ac55622bab90cb2cfed1a7c93c4d40d9
+  metadata.gz: 1a41113305d82bb450ff44367a7a66060a882977bd120b6b13ffa2bc55d1d80afcc1535bf969e7b30aeb984770be2aa8c0195c183de7f594ad585de8b82b3860
+  data.tar.gz: 0c59bf275fabdc82837deeeeee0405f4b7e13047270b7b2bd95492191088e42e6574a1d67f4c7df2d236b1cca9407dbea2e068a7d033fd55e40c578cfcb204cb

data/README.md

@@ -119,7 +119,7 @@ These settings apply to both site types (hub and project).
 
   tagline: Site tagline
   pitch: Site pitch
-  # The above two are used on home hero unit.
+  # The above two are used in home hero unit.
 
   social:
     links:
@@ -348,7 +348,6 @@ algolia_search:
   index_name: '<your Algolia index name>'
 # Only add this if you want to use Algolia’s search on your project site.
 
-# NOTE: Must match corresponding hub site’s configuration entry.
 tag_namespaces:
   software:
     namespace_id: "Human-readable namespace name"
@@ -356,6 +355,20 @@ tag_namespaces:
     # writtenin: "Written in"
   specs:
     namespace_id: "Human-readable namespace name"
+# NOTE: Tag namespaces must match corresponding hub site’s configuration entry.
+
+landing_priority: [custom_intro, blog, specs, software]
+# Which order should sections be displayed on landing.
+#
+# Default order: [software, specs, blog]
+# Depending on your project’s focus & pace of development you may want to change that.
+# Supported sections: featured_posts, featured_software, featured_specs, custom_intro.
+#
+# If you use custom_intro, project site must define an include "custom-intro.html".
+# The contents of that include will be wrapper in section.custom-intro tag.
+# Inside the include you’d likely want to have introductory summary wrapped
+# in section.summary, and possibly custom call-to-action buttons
+# (see Metanorma.com site for an example).
 ```
 
 ### File structure
@@ -470,6 +483,7 @@ description: A sentence.
 # Not necessarily shown to the user,
 # but used for HTML metadata if jekyll-seo-tag is enabled
 
+tags: [Ruby, Python, RFC, "<some_namespace_id>:<appropriate_tag>"]
 # Note: Avoid whitespaces and other characters that may make Jekyll
 # percent-encode the tag in URLs. Replace " " (a regular space)
 # with "_" (underline); underlines will be rewritten as spaces when tags
@@ -478,7 +492,23 @@ description: A sentence.
 # e.g. chosen programming language or target viewer audience
 # (see hub site configuration for tag namespace setup).
 # Avoid long namespace/tag combos as they can overflow item’s card widget.
-tags: [Ruby, Python, RFC, "<some_namespace_id>:<appropriate_tag>"]
+
+external_links:
+  - url: https://github.com/riboseinc/asciidoctor-rfc
+  - url: https://docs.rs/proj/ver/…/
+  - { url: https://example.com/, title: "Custom title" }
+# External links.
+# For software, typically points to docs sites or source code repository.
+# For specs, this usually contains RFC, IETF links, spec source code.
+# * Link label can be specified with the title key.
+#   Select URLs are recognized and an appropriate label
+#   (possibly icon) is shown by default,
+#   otherwise you **should** specify the title.
+#   Currently, recognized URLs include
+#   GitHub, Docs.rs, RubyDoc,
+#   ietf.org/html/rfcN, datatracker.ietf.org/doc/…
+# * Order links according to importance for project site visitors.
+#   The first link will be highlighted as primary. 
 
 feature_with_priority: 1
 # With this key, software or spec will be featured on home
@@ -497,16 +527,14 @@ YAML frontmatter required for software:
 ```yaml
 repo_url: https://github.com/riboseinc/asciidoctor-rfc
 # Required.
+# Used for things like showing how long ago
+# the was project updated last.
 
-docs:
+docs_source:
   git_repo_url: git@example.com:path/to-repo.git
   git_repo_subtree: docs
-# Docs that would be made part of open project site.
+# Documentation, the contents of which will be made part of the project site.
 # See the nearby section about documentation.
-
-docs_url: https://docs.rs/proj/ver/…/
-# External docs. For some links
-# like docs.rs and rubydoc, special icon and/or label will be shown.
 ```
 
 #### Displaying software docs
@@ -519,12 +547,11 @@ only frontmatter, following this sample:
 ---
 items:
 - title: Introduction
+  path: intro/
   items:
-    - { title: Overview, path: overview/ }
-    - { title: Installation, path: installation/ }
-- title: Usage
-  items:
-    - { title: Basic, path: basic-usage/ }
+    - { title: Overview, path: intro/overview/ }
+    - { title: Installation, path: intro/installation/ }
+- { title: Usage, path: usage/ }
 ---
 
 = Navigation
@@ -544,26 +571,13 @@ the navigation.
 YAML frontmatter specific to specs:
 
 ```yaml
-rfc_id: XXXX
-# IETF RFC URL would be in the form 
-# http://ietf.org/html/rfc<id>
-
-ietf_datatracker_id: some-string-identifier-here
-ietf_datatracker_ver: "01"
-# IETF datatracker URL would be in the form
-# https://datatracker.ietf.org/doc/<id>[-<version>]
-
-source_url: https://example.com/spec-source-markup
-# Required.
-
-
-# For displaying spec contents, see below:
-
 spec_source:
   git_repo_url: https://github.com/<user>/<repo>
   git_repo_subtree: images
   build:
     engine: png_diagrams
+# See below about building the spec from its source
+# to be displayed on the site.
 
 navigation:
   sections:
@@ -727,33 +741,36 @@ The rule would look like this:
 
 ### SASS variables
 
-Following are the variables along with their defaults:
+Following are principal variables that define the appearance of a site
+built with this theme, along with their defaults.
+
+For a project site, wisely choosing primary and accent colors should be enough
+as a minimum.
 
 ```scss
 $font-family: Helvetica, Arial, sans-serif !default;
+$main-font-color: black !default;
 
-# Primary color—should be bright but dark enough to be readable,
-# since some text elements are set using this color:
+# Primary color & accent colors are used throughout site’s UI.
+# Make sure to use shades dark enough that white text is readable on top,
+# especially with the primary color.
+# Make sure these colors go well with each other.
 $primary-color: lightblue !default;
+$accent-color: red !default;
 
-# Darker variation of primary color used for background on elements where
-# text is set in white:
-$primary-dark-color: navy !default;
+# These colors are used for warning/info blocks within body text.
+$important-color: orange !default;
+$warning-color: red !default;
 
-# Bright color for accent elements, such as buttons (not yet in use).
-# Text on those elements is set in bold and white, so this color
-# should be dark enough:
-$accent-color: red !default;
+# Background used on home page body & other pages’ hero unit backgrounds.
+$main-background: linear-gradient(315deg, $accent-color 0%, $primary-color 74%) !default;
 
-# Below are used for `background` CSS rule for top header, and for
-# hero unit respectively. Gradients can be supplied.
-$header-background: $primary-dark-color !default;
-$hero-background: $primary-dark-color !default;
+# This background defaults to $main-background value.
+$header-background: $main-background !default;
 
-# This is for the big big hero unit on home page.
-$superhero-background: $primary-dark-color !default;
 
-# Below customize colors for different sections of the site.
+# Below does not apply to project sites (only the hub site):
+
 $hub-software--primary-color: lightsalmon !default;
 $hub-software--primary-dark-color: tomato !default;
 $hub-software--hero-background: $hub-software--primary-dark-color !default;
@@ -763,6 +780,10 @@ $hub-specs--primary-dark-color: palevioletred !default;
 $hub-specs--hero-background: $hub-specs--primary-dark-color !default;
 ```
 
+TIP: A good way to find a good match for primary-color and accent-color
+may be the eggradients.com website. Find a suitable, dark enough gradient and pick
+one color as primary, and the other as accent.
+
 
 ## Extra .gitignore rules
 

data/_config.yml

@@ -17,6 +17,14 @@ exclude:
   - /_projects/**/docs/*
   - .sass-cache/
 
+unmarked_external_link_selectors:
+  - .layout--home a
+  - a[href*=travis]
+  - a[href*=coverity]
+  - a[href*=codecov]
+
+landing_priority: [software, specs, blog]
+
 collections:
   projects:
     output: false

data/_includes/_nav-item.html

@@ -12,7 +12,7 @@
   {% comment %} Otherwise in Liquid selected value falls through to next include instance {% endcomment %}
 {% endif %}
 
-<li class="item {% if selected %}selected{% endif %}">
+<li class="{% if selected %}selected{% endif %}">
   <div class="item-title"
       title="{{ include.item.title }}{% if include.item.description %} ({{ include.item.description }}){% endif %}">
     {% if include.item.path == null or selected == true %}
@@ -26,11 +26,13 @@
     {% endif %}
   </div>
 
-  {% if include.item.items %}
-    <ul class="nav-items subitmes">
-      {% for item in include.item.items %}
-        {% include _nav-item.html item=item base_url=include.base_url selected_item=include.selected_item %}
-      {% endfor %}
-    </ul>
+  {% if include.top_level_only != true %}
+    {% if include.item.items %}
+      <ul class="nav-items subitmes">
+        {% for item in include.item.items %}
+          {% include _nav-item.html item=item base_url=include.base_url selected_item=include.selected_item %}
+        {% endfor %}
+      </ul>
+    {% endif %}
   {% endif %}
 </li>

data/_includes/external-link.html

@@ -0,0 +1,59 @@
+<a href="{{ include.url }}">
+
+  {% if include.url contains "github.com" %}
+    <span class="ico">
+      <i class="fab fa-github"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "GitHub" }}
+    </span>
+
+  {% elsif include.url contains "rubygems.org" %}
+    <span class="ico">
+      <i class="far fa-gem"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "Gem" }}
+    </span>
+
+  {% elsif include.url contains "crates.io/crates" %}
+    <span class="ico">
+      <i class="far fa-cubes"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "Crate" }}
+    </span>
+
+  {% elsif include.url contains "rubydoc" %}
+    <span class="ico">
+      <i class="far fa-gem"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "RubyDoc" }}
+    </span>
+
+  {% elsif include.url contains "docs.rs" %}
+    <span class="ico">
+      <i class="far fa-book"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "Docs.rs" }}
+    </span>
+
+  {% elsif include.url contains "ietf.org/html/rfc" %}
+    <span class="lbl">
+      {{ include.title | default: "IETF RFC" }}
+    </span>
+
+  {% elsif include.url contains "datatracker.ietf.org" %}
+    <span class="lbl">
+      {{ include.title | default: "IETF document" }}
+    </span>
+
+  {% else %}
+    <span class="lbl">
+      {{ include.title }}
+    </span>
+
+  {% endif %}
+</a>

data/_includes/featured_posts.html

@@ -0,0 +1,11 @@
+{% assign posts = site.posts_combined %}
+
+<section class="featured-posts">
+  <h2 class="title">From the <a href="/blog/">Blog</a></h2>
+
+  <div class="items">
+    {% for item in posts | limit: site.max_featured_posts %}
+      {% include post-card.html post=item %}
+    {% endfor %}
+  </div>
+</section>

data/_includes/featured_software.html

@@ -0,0 +1,55 @@
+<section class="software">
+  {% unless site.one_software %}
+    <h2 class="title">
+      Software
+      {% if site.num_all_software > site.num_featured_software %}
+        — <a href="/software/">see all</a>
+      {% endif %}
+    </h2>
+  {% endunless %}
+
+  <div class="items">
+    {% assign software = site.featured_software %}
+    {% for item in software | limit: site.max_featured_software %}
+      {% assign url = item.url %}
+      {% assign item_docs = site.software | where_exp: "item", "item.url contains url" %}
+      {% assign item_data = site.software | where_exp: "item", "item.url == url" | first %}
+      {% assign nav = item_docs | where_exp: "item", "item.path contains 'docs/navigation'" | first %}
+
+      <div class="item" role="article">
+        {% unless site.one_software %}
+          <header>
+            <div class="logo-container">
+              {% include software-symbol.html item_id=item.id %}
+            </div>
+
+            <h3 class="title"><a href="{{ item.url }}">{{ item.title }}</a></h3>
+          </header>
+
+          <p class="body">
+            {{ item.description }}
+          </p>
+        {% endunless %}
+
+        {% assign top_level_nav_item_with_path = nav.items | where_exp: "item", "item.path" | first %}
+        {% if nav and top_level_nav_item_with_path %}
+          <div class="docs-nav">
+            {% assign docs_base_url = item.url | append: "docs/" %}
+            {% assign nav_items = nav.items | slice: 0, 3 %}
+            <ul class="nav-items">
+              {% for nav_item in nav_items %}
+                {% include _nav-item.html item=nav_item base_url=docs_base_url top_level_only=true %}
+              {% endfor %}
+            </ul>
+          </div>
+        {% endif %}
+
+        <div class="external-links">
+          <ul class="nav-items">
+            {% include item-external-links.html item_data=item_data %}
+          </ul>
+        </div>
+      </div>
+    {% endfor %}
+  </div>
+</section>

data/_includes/featured_specs.html

@@ -0,0 +1,31 @@
+<section class="specs">
+  <h2 class="title">
+    Specification{% if site.num_all_specs > 1 %}s{% endif %}
+    {% if site.num_all_specs > site.num_featured_specs %}
+      — <a href="/specs/">see all</a>
+    {% endif %}
+  </h2>
+  <div class="items">
+    {% assign specs = site.featured_specs %}
+    {% for item in specs | limit: site.max_featured_specs %}
+      {% assign url = item.url %}
+      {% assign item_data = site.specs | where_exp: "item", "item.url == url" | first %}
+
+      <div class="item" role="article">
+        <header>
+          <h3 class="title"><a href="{{ item.url }}">{{ item.title }}</a></h3>
+        </header>
+
+        <p class="body">
+          {{ item.description }}
+        </p>
+
+        <div class="external-links">
+          <ul class="nav-items">
+            {% include item-external-links.html item_data=item_data %}
+          </ul>
+        </div>
+      </div>
+    {% endfor %}
+  </div>
+</section>

data/_includes/home-hero.html

@@ -1,14 +1,20 @@
 <div class="text">
   <h1 class="title">{{ site.tagline }}</h1>
-  <p class="desc">{{ site.pitch | safe }}</p>
 
-  <div class="cta">
-    {% if site.is_hub %}
+  {% if site.pitch %}
+    <p class="desc">{{ site.pitch | safe }}</p>
+  {% endif %}
+
+  {% if site.is_hub %}
+    <div class="cta">
       <a class="button" href="{{ "/projects/" | relative_url }}">
         <i class="icon far fa-search"></i>
         Explore Projects
       </a>
-    {% else if %}
+    </div>
+  {% else if site.one_software %}
+  {% else %}
+    <div class="cta">
       {% assign ctas = site.home_calls_to_action | slice: 0, 2 %}
 
       {% for link in ctas %}
@@ -16,11 +22,6 @@
           {{ link.title }}
         </a>
       {% endfor %}
-    {% endif %}
-  </div>
-</div>
-<div class="illustration">
-  <div role="presentation" class="logo">
-    {% include assets/symbol.svg %}
-  </div>
+    </div>
+  {% endif %}
 </div>