jekyll-theme-rop 2.1.15

data/_config.yml

@@ -0,0 +1,89 @@
+markdown: kramdown
+
+includes_dir: .
+
+permalink: /blog/:year-:month-:day-:title/
+
+# algolia_search:
+#   api_key: ''
+#   index_name: ''
+# Uncomment this if you want to use Algolia’s search.
+# It’s free for open-source projects.
+
+exclude:
+  - home-hero.html
+  - title.html
+  - nav-links.html
+  - flavor-sample-summary.html
+  - project-nav.html
+  - /**/.git/*
+  - /_projects/**/_*_repo/*
+  - /_projects/*/assets/css/*
+  - /_projects/**/docs/*
+  - .sass-cache/
+
+external_links:
+  selector: 'body.site--project main a, body.site--hub.layout--post main a'
+  ignored_selectors:
+    - .layout--home a
+    - a[href*=travis]
+    - a[href*=coverity]
+    - a[href*=codecov]
+
+landing_priority: [software, specs, blog]
+
+plugins:
+  - jekyll-theme-rop
+  - jekyll-seo-tag
+  - jekyll-sitemap
+  - jekyll-data
+  - jekyll-asciidoc
+  - jekyll-redirect-from
+  - kramdown-parser-gfm
+  - kramdown-syntax-coderay
+
+collections:
+  projects:
+    output: false
+  software:
+    output: true
+    permalink: /software/:path/
+  specs:
+    output: true
+    permalink: /specs/:path/
+  posts:
+    output: true
+    permalink: /blog/:month-:day-:year/:title/
+  pages:
+    output: true
+    permalink: /:name/
+
+fontawesome_cdn:
+  version: v5.8.1
+  integrity: "sha384-g5uSoOSBd7KkhAMlnQILrecXvzst9TdC09/VM+pjDTCM+1il8RHz5fKANTFFb+gQ"
+# Only applies if no_auto_fontawesome is not set.
+
+no_auto_fontawesome: false
+# If set to yes, site (with default design) must specify <script> elements
+# that make required FA styles available in SVG mode.
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: default
+  - scope:
+      path: _posts
+      type: posts
+    values:
+      layout: post
+  - scope:
+      path: _software
+      type: software
+    values:
+      layout: product
+  - scope:
+      path: _specs
+      type: specs
+    values:
+      layout: spec

data/_includes/_nav-item.html

@@ -0,0 +1,38 @@
+{% assign base_url = include.base_url | default: "" %}
+{% assign link = base_url | append: include.item.path %}
+
+{% if include.item == include.selected_item %}
+  {% assign selected = true %}
+  {% assign selected_item = include.item %}
+{% elsif include.selected_item == null and page.url == link %}
+  {% assign selected = true %}
+  {% assign selected_item = include.item %}
+{% else %}
+  {% assign selected = false %}
+  {% comment %} Otherwise in Liquid selected value falls through to next include instance {% endcomment %}
+{% 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 %}
+      <span>
+        {{ include.item.title }}
+      </span>
+    {% else %}
+      <a href="{{ link }}">
+        {{ include.item.title }}
+      </a>
+    {% endif %}
+  </div>
+
+  {% 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/_post-meta.html

@@ -0,0 +1,24 @@
+{% assign authors = "" | split: "," %}
+{% if include.post.author %}
+  {% assign authors = authors | push: include.post.author %}
+{% endif %}
+{% if include.post.authors %}
+  {% assign authors = authors | concat: include.post.authors %}
+{% endif %}
+{% assign num_authors = authors | size %}
+
+<span class="authors">
+  {% for author in authors %}
+    <span class="author">
+      {% if author.name %}
+        {% include post-author-pic.html author=author %}
+        <span class="author-name">{{ author.name }}</span>
+      {% endif %}
+    </span>
+  {% endfor %}
+</span>
+
+<span class="date">
+  {% if num_authors > 0 %}on {% endif %}
+  {{ include.post.date | date_to_string }}
+</span>

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="fas fa-gem"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "Gem" }}
+    </span>
+
+  {% elsif include.url contains "crates.io/crates" %}
+    <span class="ico">
+      <i class="fas fa-cubes"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "Crate" }}
+    </span>
+
+  {% elsif include.url contains "rubydoc" %}
+    <span class="ico">
+      <i class="fas fa-gem"></i>
+    </span>
+    <span class="lbl">
+      {{ include.title | default: "RubyDoc" }}
+    </span>
+
+  {% elsif include.url contains "docs.rs" %}
+    <span class="ico">
+      <i class="fas 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/head.html

@@ -0,0 +1,9 @@
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+{% if page.custom_css %}
+  {% for stylesheet in page.custom_css %}
+    <link rel="stylesheet" href="{{ stylesheet | relative_url }}">
+  {% endfor %}
+{% endif %}
+{% seo %}

data/_includes/home-hero.html

@@ -0,0 +1,27 @@
+<div class="text">
+  <h1 class="title">{{ site.tagline }}</h1>
+
+  {% 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 fas fa-search"></i>
+        Explore Projects
+      </a>
+    </div>
+  {% else if site.one_software %}
+  {% else %}
+    <div class="cta">
+      {% assign ctas = site.home_calls_to_action | slice: 0, 2 %}
+
+      {% for link in ctas %}
+        <a class="button" href="{{ link.url | relative_url }}">
+          {{ link.title }}
+        </a>
+      {% endfor %}
+    </div>
+  {% endif %}
+</div>

data/_includes/home-hub.html

@@ -0,0 +1,81 @@
+{% assign projects = site.projects | where_exp: "item", "item.home_url != nil" %}
+{% assign posts = site.posts_combined %}
+{% assign num_posts = site.num_posts_combined %}
+
+{% 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>
+
+    <div class="items">
+
+      {% for item in featured_projects limit:3 %}
+        <a class="item" href="{{ item.home_url }}" role="article">
+          <header>
+            <div class="logo-container">
+              {% assign symbol_path = item.path | split: "/" | slice: 1, 1 | join: "/" | append: "/assets/symbol.svg" %}
+              {% assign relative_symbol_path = "/projects/" | append: symbol_path %}
+              <div class="logo"><img src="{{ 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">Visit Site</div>
+          </div>
+        </a>
+      {% endfor %}
+    </div>
+  </section>
+{% endif %}
+
+{% if num_posts > 0 %}
+  <section class="featured-posts">
+    <div class="puny-label">Latest news</div>
+    <h2 class="title">From the Blog</h2>
+
+    <div class="items">
+      {% for item in posts limit:3 %}
+        {% include post-card.html post=item %}
+      {% endfor %}
+    </div>
+  </section>
+{% endif %}
+
+{% assign other_projects = projects | where: "featured", false %}
+{% assign num_other_projects = other_projects | size %}
+{% if num_other_projects > 0 %}
+<section class="other-projects">
+  {% include assets/symbol.svg %}
+
+  <h2 class="title">Other Projects</h2>
+
+  <div class="items {% if num_other_projects < 5 %}one-row{% endif %}">
+    {% for item in other_projects %}
+      <a class="item" href="{{ item.home_url }}" role="article">
+        <header>
+          <div class="logo-container">
+            {% assign symbol_path = item.path | split: "/" | slice: 1, 1 | join: "/" | append: "/assets/symbol.svg" %}
+            {% assign relative_symbol_path = "/projects/" | append: symbol_path %}
+            <div class="logo"><img src="{{ relative_symbol_path }}"></div>
+          </div>
+          <h3 class="title">{{ item.title }}</h3>
+        </header>
+
+        <p class="body">
+          {{ item.description }}
+        </p>
+
+        <footer class="meta">
+          {% include tag-list.html tags=item.tags %}
+        </footer>
+      </a>
+    {% endfor %}
+  </div>
+</section>
+{% endif %}

data/_includes/home-project.html

@@ -0,0 +1,19 @@
+{% assign num_featured_software = site.featured_software | size %}
+{% assign num_featured_specs = site.featured_specs | size %}
+{% assign num_posts = site.num_posts_combined %}
+
+{% assign num_posts_specs = num_posts | plus: num_featured_specs %}
+
+{% for section_name in site.landing_priority %}
+  {% if section_name == "specs" and num_featured_specs > 0 %}
+    {% include featured_specs.html %}
+  {% elsif section_name == "software" and num_featured_software > 0 %}
+    {% include featured_software.html %}
+  {% elsif section_name == "blog" and num_posts > 0 %}
+    {% include featured_posts.html %}
+  {% elsif section_name == "custom_intro" %}
+    <section class="custom-intro">
+      {% include custom-intro.html %}
+    </section>
+  {% endif %}
+{% endfor %}

data/_includes/index-page-hero.html

@@ -0,0 +1,3 @@
+<div class="text">
+  <h1 class="title">{{ page.title }}</h1>
+</div>

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

@@ -0,0 +1,83 @@
+{% 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 include.tag %}
+  {% if include.tag contains ":" %}
+    {% assign tag_namespace = include.tag | split: ":" | first %}
+  {% else %}
+    {% assign tag_namespace = "" %}
+  {% endif %}
+{% endif %}
+
+{% if num_tags > 0 %}
+  <nav class="item-filter">
+    {% comment %}Non-namespaced tags{% endcomment %}
+    <ul class="tags">
+      {% for tag in tags %}
+        {% if tag contains ":" %}
+          {% assign _namespace = tag | split: ":" | first %}
+        {% else %}
+          {% assign _namespace = "" %}
+        {% endif %}
+
+        {% if _namespace == "" %}
+          <li>
+            {% assign tag_human = tag | replace: "_", " " %}
+            {% if tag == include.tag %}
+              <span>{{ tag_human }}</span>
+            {% else %}
+              <a href="{{ include.url_tag_prefix }}{{ tag }}">{{ tag_human }}</a>
+            {% endif %}
+          </li>
+        {% endif %}
+      {% endfor %}
+    </ul>
+
+    {% comment %}Namespaced tags{% endcomment %}
+    {% for namespace in site.tag_namespaces[include.tag_namespaces] %}
+      {% assign namespace_human = namespace[1] %}
+      {% assign namespace_id = namespace[0] %}
+
+      <div class="namespace">
+        <span class="namespace-title">{{ namespace_human }}: </span>
+
+        <ul class="tags">
+          {% for tag in tags %}
+            {% if tag contains ":" %}
+              {% assign _namespace = tag | split: ":" | first %}
+            {% else %}
+              {% assign _namespace = "" %}
+            {% endif %}
+
+            {% if _namespace == namespace_id %}
+              <li>
+                {% assign tag_human = tag | split: ":" | last | replace: "_", " " %}
+                {% if tag == include.tag %}
+                  <span>{{ tag_human }}</span>
+                {% else %}
+                  <a href="{{ include.url_tag_prefix }}{{ tag }}">{{ tag_human }}</a>
+                {% endif %}
+              </li>
+            {% endif %}
+          {% endfor %}
+        </ul>
+      </div>
+    {% endfor %}
+  </nav>
+{% endif %}
+
+{% if include.tag %}
+  {% assign tag_human = include.tag | split: ":" | last | replace: "_", " " %}
+  {% if tag_namespace != "" %}
+    {% assign namespace = site.tag_namespaces[include.tag_namespaces][tag_namespace] %}
+  {% endif %}
+  <header class="filter-header">
+    <h3 class="title">
+      Showing items matching
+      <span class="tag">{% if namespace %}<span class="namespace">{{ namespace }}:</span> {% endif %}{{ tag_human }}</span>
+      <a class="show-all" href="{{ include.url_tag_prefix }}">(show all)</a>
+    </h3>
+  </header>
+{% endif %}

data/_includes/item-doc-page.html

@@ -0,0 +1,138 @@
+{% comment %}
+This page conforms to the structure introduced by docs-base layout,
+supporting expandable navigation widget.
+{% endcomment %}
+
+{% assign product_base_url = page.url | split: "/" | slice: 0, 3 | join: "/" | append: "/" %}
+
+{% if page.url == product_base_url %}
+  {% assign is_docs_landing = true %}
+{% else %}
+  {% assign is_docs_landing = false %}
+{% endif %}
+
+{% assign item_docs = include.items | where_exp: "item", "item.url contains product_base_url" %}
+{% assign nav = item_docs | where_exp: "item", "item.path contains 'docs/navigation'" | first %}
+{% if nav == nil %}
+  {% assign nav = page.navigation || layout.navigation %}
+{% endif %}
+
+{% assign num_top_nav_items = nav.items | size %}
+{% assign item_data = include.items | where_exp: "item", "item.url == product_base_url" | first %}
+
+{% if item_data['docs']['git_repo_subtree'] %}
+  {% assign docs_base_url = product_base_url | append: item_data['docs']['git_repo_subtree'] | append: "/" %}
+{% else %}
+  {% assign docs_base_url = product_base_url %}
+{% endif %}
+
+{% if is_docs_landing != true %}
+  <header class="documentation-header {% if num_top_nav_items > 0 %} has-nav {% endif %}">
+    <div class="nav-header">
+      {% if site.one_software %}
+        <h3 class="title">
+          Docs
+        </h3>
+      {% else %}
+        {% if include.item_type == 'software' %}
+          <div class="logo-container">
+            {% include software-symbol.html item_id=page.id %}
+          </div>
+        {% endif %}
+
+        <h3 class="title">
+          <a href="javascript: void 0;">{{ item_data.title }}</a>
+        </h3>
+      {% endif %}
+
+      {% if num_top_nav_items > 0 %}
+        <span class="nav-toggle-icon">
+          <i class="open fas fa-ellipsis-v"></i>
+          <i class="close fas fa-times"></i>
+        </span>
+      {% endif %}
+    </div>
+  </header>
+{% endif %}
+
+<section class="documentation {% if is_docs_landing %}docs-landing{% endif %} {{ include.item_type }}">
+
+  {% if is_docs_landing == false %}
+    <nav class="docs-nav">
+      <ul class="nav-items">
+
+        <li class="item external-links">
+          <ul class="nav-items">
+            <li class="item home-link" title="Documentation index">
+              <a href="{{ product_base_url | relative_url }}">
+                <span class="ico">
+                  <i class="fas fa-home"></i>
+                </span>
+                <span class="lbl">
+                  Home
+                </span>
+              </a>
+            </li>
+            {% include item-external-links.html item_data=item_data %}
+          </ul>
+        </li>
+
+        {% for item in nav.items %}
+          {% include _nav-item.html item=item base_url=docs_base_url %}
+        {% endfor %}
+
+      </ul>
+    </nav>
+  {% endif %}
+
+  <article>
+    <header>
+      <div class="title">
+        {% if include.item_type == 'software' and page.url == product_base_url %}
+          <div class="logo-container">
+            {% include software-symbol.html item_id=page.id %}
+          </div>
+        {% endif %}
+
+        <h1 class="text">{{ page.article_header_title | default: page.title }}</h1>
+      </div>
+
+      {% if is_docs_landing == false %}
+        <nav role="toolbar">
+          <button class="docs-nav-toggle">Toggle table of contents</button>
+
+          {% assign suggest_edits_base_url = item_data.docs.git_repo_url | default: item_data.repo_url %}
+          {% if suggest_edits_base_url %}
+            <a href="{{ suggest_edits_base_url }}/edit/{{ item_data.docs.git_repo_branch | default: site.default_repo_branch | default: 'main' }} /{{ item_data.docs.git_repo_subtree | default: "docs" }}/{{ page.path | split: "/" | last }}" class="docs-suggest-edits">Suggest edits to this page</a>
+          {% endif %}
+        </nav>
+      {% endif %}
+
+      <div>
+        <h3 class="lead">{{ page.description }}</h3>
+      </div>
+
+      {% if is_docs_landing %}
+        <div class="external-links">
+          <ul class="nav-items">
+            {% include item-external-links.html item_data=item_data %}
+          </ul>
+        </div>
+      {% endif %}
+    </header>
+
+    <div class="body">
+      {{ content }}
+    </div>
+
+    {% assign nav_size = nav.items | size %}
+    {% if is_docs_landing and nav_size > 0 %}
+      <ul class="nav-items">
+        {% for item in nav.items %}
+          {% include _nav-item.html item=item base_url=docs_base_url %}
+        {% endfor %}
+      </ul>
+    {% endif %}
+
+  </article>
+</section>