cmu-web-jekyll-and-plaid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de1d96b7976f0cdcf767330b65447d9dabc990aba3646c4434a1df5cf4137487
+  data.tar.gz: 37125573f340c4034a7d6c8864d69bd481d50ea909bd644400a7d1f28727a7fc
+SHA512:
+  metadata.gz: 3a09384c63220970c7c7432b5fc4f3958cb56682a9846a45e2159aca31f3a39f8143e63d1d3e943b7874afebfcb0dd38f0bc74981d6f94765c61d0d59445020a
+  data.tar.gz: eefba41331e1985e8b7af7295bb7b777a1efc6d46c456bcbf980f3efd15785256dd164bc7a7671a809ad60128a06df0b53956375e814ad4f6a8ddbac6d89d4e0

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Carnegie Mellon University
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,65 @@
+# Jekyll & Plaid as a Gem
+
+Jekyll & Plaid is a Jekyll theme in Carnegie Mellon style: Markdown docs
+pages and full-width home pages in CMU's web template, with the
+[Carnegie Mellon Web Kilt](https://webkilt.andrew.cmu.edu/). This gem is
+for sites you build yourself with Jekyll 4, locally or in GitHub Actions.
+
+The gem lives in the theme repository's `packages/jekyll/`. Each release
+of the theme publishes it at the same version.
+
+## On GitHub Pages
+
+GitHub Pages builds only its own list of theme gems, so a Pages site uses
+the theme straight from GitHub instead; it doesn't take this gem. In
+`_config.yml`:
+
+```yaml
+remote_theme: cmu-web/cmu-web-jekyll-and-plaid
+```
+
+## In Your Own Build
+
+Add the gem to your site's `Gemfile`:
+
+```ruby
+gem 'jekyll', '~> 4.4'
+gem 'cmu-web-jekyll-and-plaid', '~> 0.1'
+```
+
+Then name the theme in `_config.yml`, with the plugins it counts on. They
+do what GitHub Pages does for every site: a layout for every page, the
+first heading as a page's title, pages without front matter, `README.md` as
+the home page and links between Markdown files.
+
+```yaml
+title: Your Office or Project
+description: A line under the name
+theme: cmu-web-jekyll-and-plaid
+plugins:
+  - jekyll-default-layout
+  - jekyll-optional-front-matter
+  - jekyll-readme-index
+  - jekyll-relative-links
+  - jekyll-titles-from-headings
+```
+
+The gem installs those plugins for you. For the footer's link to your
+repository, add `jekyll-github-metadata` to your `Gemfile` and plugins too,
+and name the repository in `_config.yml` (`repository: your-org/your-repo`).
+
+[Writing Pages](https://jekyllandplaid.andrew.cmu.edu/writing.html) covers
+the pages, the home page's sections and the settings you can change.
+
+## Work on the Gem
+
+```bash
+cd packages/jekyll
+bundle install
+bundle exec rake test build
+```
+
+`rake assets` (run by `test` and `build`) copies the theme's `_layouts/`,
+`_includes/` and `assets/` and the license into the gem, and takes its
+version from the latest release tag. The test builds a small Markdown site
+with the theme. `rake clean` removes the copies and the build.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/_includes/cmu/breadcrumbs.html

@@ -0,0 +1,8 @@
+    {%- unless home %}
+    <div class="breadcrumbs">
+      {%- if parent.url %}
+      <a href="{{ parent.url }}">{{ parent.title }}</a>&nbsp;&rsaquo;&nbsp;
+      {%- endif -%}
+      <a href="{{ '/' | relative_url }}">{{ site.title }}</a>&nbsp;&rsaquo;&nbsp;{{ page.title }}
+    </div>
+    {%- endunless %}

data/_includes/cmu/footer.html

@@ -0,0 +1,27 @@
+  <footer class="grid column3 invert">
+    <div>
+      <p>{{ office }}<br>{{ address | join: "<br>" }}{% if footer.phone %}<br>{{ footer.phone }}{% endif %}{% if footer.email %}<br><a href="mailto:{{ footer.email }}">Contact Us</a>{% endif %}</p>
+      <ul>{% for l in footer.links %}<li><a href="{{ l.url }}">{{ l.title }}</a></li>{% endfor %}<li><a href="https://www.cmu.edu/legal/">Legal Info</a></li><li><a href="https://www.cmu.edu/">www.cmu.edu</a></li></ul>
+      <ul><li>&copy; {{ site.time | date: "%Y" }} Carnegie Mellon University</li></ul>
+    </div>
+    <div></div>
+    <div>
+      <nav id="nav">
+        <ul>
+          {%- for p in navpages %}
+          {%- if p.url == page.url %}
+          <li class="active"><a href="{{ p.url | relative_url }}" aria-current="page">{{ p.title }}</a></li>
+          {%- else %}
+          <li><a href="{{ p.url | relative_url }}">{{ p.title }}</a></li>
+          {%- endif %}
+          {%- endfor %}
+          {%- for l in cmu.nav_links %}
+          <li class="secondary"><a class="external" href="{{ l.url }}">{{ l.title }}</a></li>
+          {%- endfor %}
+          {%- if site.github.repository_url %}
+          <li class="secondary"><a class="external" href="{{ site.github.repository_url }}">{{ site.title }} on GitHub</a></li>
+          {%- endif %}
+        </ul>
+      </nav>
+    </div>
+  </footer>

data/_includes/cmu/head.html

@@ -0,0 +1,32 @@
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  {%- assign summary = page.description | default: site.description %}
+  {%- if summary %}
+  <meta name="description" content="{{ summary | strip_html | escape }}">
+  {%- endif %}
+  <title>{% unless home %}{{ page.title }} - {% endunless %}{{ site.title }} - Carnegie Mellon University</title>
+  {%- comment -%} Link previews: the kit's Link Previews standard {%- endcomment %}
+  <meta property="og:type" content="{% if page.date and page.author %}article{% else %}website{% endif %}">
+  <meta property="og:site_name" content="{{ site.title | escape }}">
+  <meta property="og:title" content="{% unless home %}{{ page.title | escape }} - {% endunless %}{{ site.title | escape }}">
+  {%- if summary %}
+  <meta property="og:description" content="{{ summary | strip_html | escape }}">
+  {%- endif %}
+  <meta property="og:url" content="{{ page.url | absolute_url }}">
+  {%- if preview %}
+  <meta property="og:image" content="{{ preview | absolute_url }}">
+  <meta property="og:image:width" content="1200">
+  <meta property="og:image:height" content="630">
+  <meta property="og:image:alt" content="{{ cmu.preview_alt | default: previewalt | escape }}">
+  <meta name="twitter:card" content="summary_large_image">
+  {%- endif %}
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,400italic,300italic,300,700,700italic" rel="stylesheet">
+  <link href="{{ tpl }}/css/main.6.7.min.css" media="screen" rel="stylesheet">
+  <link href="{{ tpl }}/css/print.min.css" media="print" rel="stylesheet">
+  <link href="{{ kitcdn }}/css/cmu-cms.css" rel="stylesheet">
+  <link href="https://www.cmu.edu/favicon.ico" rel="icon">
+  <link href="https://www.cmu.edu/favicon-152.png" rel="apple-touch-icon-precomposed">
+  <meta content="#9f0000" name="msapplication-TileColor">
+  <meta content="https://www.cmu.edu/favicon-144.png" name="msapplication-TileImage">
+</head>

data/_includes/cmu/header.html

@@ -0,0 +1,14 @@
+  <header>
+    <div class="roof {{ roof }}">
+      <div>
+        <a class="wordmark" href="https://www.cmu.edu/">Carnegie Mellon University</a>
+        <button type="button" aria-label="toggle menu" aria-pressed="false" class="menu-btn" href="#nav"><b>&#8212;</b><b>&#8212;</b><b>&#8212;</b></button>
+      </div>
+    </div>
+    <div id="sitename">
+      <span class="sitetitle"><a href="{{ '/' | relative_url }}">{{ site.title }}</a></span>
+      {%- if site.description %}
+      <h2>{% if parent.url %}<a href="{{ parent.url }}">{{ site.description }}</a>{% else %}{{ site.description }}{% endif %}</h2>
+      {%- endif %}
+    </div>
+  </header>

data/_includes/cmu/scripts.html

@@ -0,0 +1,8 @@
+<script src="{{ tpl }}/js/list.min.js"></script>
+<script src="{{ tpl }}/js/jquery-1.10.1.min.js"></script>
+<script src="{{ tpl }}/js/main.6.7.min.js"></script>
+{%- if page.carousel %}
+<script src="{{ tpl }}/js/flickity.pkgd.min.js"></script>
+{%- endif %}
+<script src="{{ kitcdn }}/js/cmu-app.js"></script>
+<script src="{{ '/assets/js/jekyll-and-plaid.js' | relative_url }}"></script>

data/_includes/cmu/settings.html

@@ -0,0 +1,31 @@
+{%- comment -%}
+  Reads the site's settings for the other includes. Every layout includes it first.
+{%- endcomment -%}
+{%- assign cmu = site.cmu -%}
+{%- assign kit = cmu.kit | default: "0.2.6" -%}
+{%- assign kitcdn = "https://cdn.jsdelivr.net/gh/cmu-web/cmu-web-kilt@" | append: kit -%}
+{%- assign tpl = "https://www.cmu.edu/common/standard-v6" -%}
+{%- assign roof = "red invert" -%}
+{%- if cmu.roof == "gray" or cmu.roof == "grey" -%}{%- assign roof = "darkgrey invert" -%}{%- elsif cmu.roof == "white" -%}{%- assign roof = "" -%}{%- endif -%}
+{%- assign home = false -%}{%- if page.url == "/" or page.url == "/index.html" -%}{%- assign home = true -%}{%- endif -%}
+{%- if cmu.nav -%}
+  {%- assign navpages = "" | split: "" -%}
+  {%- for name in cmu.nav -%}
+    {%- assign found = site.html_pages | where: "path", name | first -%}
+    {%- if found -%}{%- assign navpages = navpages | push: found -%}{%- endif -%}
+  {%- endfor -%}
+{%- else -%}
+  {%- assign listed = site.html_pages | where_exp: "p", "p.title" | where_exp: "p", "p.nav_exclude != true" | where_exp: "p", "p.url != '/'" | where_exp: "p", "p.url != '/index.html'" -%}
+  {%- comment -%} Pages with a nav_order first, in that order; then the rest, by title {%- endcomment -%}
+  {%- assign ordered = listed | where_exp: "p", "p.nav_order" | sort: "nav_order" -%}
+  {%- assign rest = listed | where_exp: "p", "p.nav_order == nil" | sort: "title" -%}
+  {%- assign navpages = ordered | concat: rest -%}
+{%- endif -%}
+{%- comment -%} The link preview image: cmu.preview, or images/preview.jpg when the site has one {%- endcomment -%}
+{%- assign preview = cmu.preview -%}
+{%- unless preview -%}{%- assign found = site.static_files | where: "path", "/images/preview.jpg" | first -%}{%- if found -%}{%- assign preview = "/images/preview.jpg" -%}{%- endif -%}{%- endunless -%}
+{%- assign previewalt = site.title | append: "'s home page." -%}
+{%- assign parent = cmu.parent -%}
+{%- assign footer = cmu.footer -%}
+{%- assign office = footer.office | default: cmu.office | default: site.title -%}
+{%- if footer.address -%}{%- assign address = footer.address -%}{%- else -%}{%- assign address = "Carnegie Mellon University|5000 Forbes Avenue|Pittsburgh, PA 15213" | split: "|" -%}{%- endif -%}

data/_layouts/default.html

@@ -0,0 +1,39 @@
+{%- comment -%}
+  Jekyll & Plaid: Markdown on GitHub Pages, in Carnegie Mellon's web template
+  with the Carnegie Mellon Web Kilt. Settings, all optional, in _config.yml:
+    title        the site's name, in the header and footer
+    description  a line under the name
+    cmu.roof     red (default), gray or white
+    cmu.kit      the Web Kilt release to load (default 0.2.6, the one the theme is tested with)
+    cmu.parent   the office or site this one belongs to (title and url): first in
+                 the breadcrumbs, and the description links to it
+    cmu.nav      the pages in the navigation, in order, by file name; without
+                 it, every page with a title, by nav_order in its front matter
+    cmu.footer   office (defaults to title), address (a list of lines),
+                 phone, email (a Contact Us link) and links (title and url)
+    cmu.nav_links  other sites to list after the pages in the navigation (title and url)
+    cmu.preview  the link preview image (default images/preview.jpg, when the site has one)
+    cmu.preview_alt  its alt text (default "<title>'s home page.")
+  Markdown's ## headings get the template's rule-top line, as section headings do in the
+  Web Kilt. Each page's description, or the site's, becomes its meta description. For a page with
+  full-width sections, use the sections layout.
+{%- endcomment -%}
+{%- include cmu/settings.html -%}
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: 'en' }}">
+{% include cmu/head.html -%}
+<body class="no-js">
+<div id="container">
+{% include cmu/header.html %}
+  <main id="content">
+{%- include cmu/breadcrumbs.html %}
+    <div class="content wide"><div>
+{{ content | replace: "<table>", '<table class="alternate cmu-full">' | replace: "<h2 id=", '<h2 class="rule-top" id=' }}
+    </div></div>
+  </main>
+
+{% include cmu/footer.html -%}
+</div>
+{% include cmu/scripts.html -%}
+</body>
+</html>

data/_layouts/sections.html

@@ -0,0 +1,24 @@
+{%- comment -%}
+  A full-width page: the same header and footer as the default layout, with the page's own
+  template sections (heroes, color bands, grids, a content area with a sidebar) placed straight
+  into #content instead of one column. Write the page in HTML. Front matter, all optional:
+    breadcrumbs  false to leave them off; the home page never has them
+    carousel     true to load the template's carousel script, for a js-flickityCustom section
+{%- endcomment -%}
+{%- include cmu/settings.html -%}
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: 'en' }}">
+{% include cmu/head.html -%}
+<body class="no-js">
+<div id="container">
+{% include cmu/header.html %}
+  <main id="content">
+{%- unless page.breadcrumbs == false %}{% include cmu/breadcrumbs.html %}{% endunless %}
+{{ content }}
+  </main>
+
+{% include cmu/footer.html -%}
+</div>
+{% include cmu/scripts.html -%}
+</body>
+</html>

data/assets/js/jekyll-and-plaid.js

@@ -0,0 +1,53 @@
+/* Jekyll & Plaid: turn what Markdown writes into the Carnegie Mellon Web Kilt's
+   components. Runs after the template's scripts and the kit's cmu-app.js. */
+(function () {
+  "use strict";
+  // The whole page, so it works in every layout; what a page writes as kit components already
+  // is left alone
+  var content = document.getElementById("content");
+  if (!content) return;
+
+  // Code blocks: a kit code block with a copy icon in its corner
+  content.querySelectorAll("pre:not(.cmu-snippet)").forEach(function (pre, i) {
+    var code = pre.querySelector("code") || pre;
+    var box = document.createElement("div");
+    box.className = "cmu-copyable";
+    var block = box.appendChild(document.createElement("pre"));
+    block.className = "cmu-snippet";
+    block.id = "cmu-code-" + (i + 1);
+    block.appendChild(document.createElement("code")).textContent = code.textContent.replace(/\n$/, "");
+    var copy = box.appendChild(document.createElement("button"));
+    copy.className = "cmu-copy";
+    copy.type = "button";
+    copy.setAttribute("data-cmu-copy", "#" + block.id);
+    copy.setAttribute("aria-label", "Copy Code");
+    copy.title = "Copy Code";
+    // Markdown wraps highlighted code in two divs; replace the outermost
+    (pre.closest(".highlighter-rouge") || pre).replaceWith(box);
+  });
+
+  // GitHub's callouts (> [!NOTE] and the like) become kit callouts with
+  // their label; any other block quote becomes a kit note
+  var LABELS = { NOTE: "Note", TIP: "Tip", IMPORTANT: "Important", WARNING: "Warning", CAUTION: "Caution" };
+  // The kit's callout colors; Important stays the plain gray callout
+  var COLORS = { NOTE: "blue", TIP: "green", WARNING: "gold", CAUTION: "red" };
+  content.querySelectorAll("blockquote").forEach(function (quote) {
+    var first = quote.querySelector("p");
+    var match = first && first.firstChild && first.firstChild.nodeType === 3 && first.firstChild.nodeValue.match(/^\s*\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]\s*/i);
+    var box = document.createElement("div");
+    if (match) {
+      first.firstChild.nodeValue = first.firstChild.nodeValue.slice(match[0].length);
+      if (!first.textContent.trim()) first.remove();
+      var kind = match[1].toUpperCase();
+      box.className = "cmu-callout" + (COLORS[kind] ? " cmu-callout--" + COLORS[kind] : "");
+      var label = document.createElement("p");
+      label.className = "cmu-label";
+      label.textContent = LABELS[kind];
+      box.appendChild(label);
+    } else {
+      box.className = "cmu-note";
+    }
+    while (quote.firstChild) box.appendChild(quote.firstChild);
+    quote.replaceWith(box);
+  });
+})();

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: cmu-web-jekyll-and-plaid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carnegie Mellon University
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: jekyll-default-layout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll-optional-front-matter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: jekyll-readme-index
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: jekyll-relative-links
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: jekyll-titles-from-headings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: 'Jekyll & Plaid builds sites with Carnegie Mellon''s web template and
+  the Carnegie Mellon Web Kilt: Markdown docs pages and full-width home pages that
+  look like cmu.edu.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- _includes/cmu/breadcrumbs.html
+- _includes/cmu/footer.html
+- _includes/cmu/head.html
+- _includes/cmu/header.html
+- _includes/cmu/scripts.html
+- _includes/cmu/settings.html
+- _layouts/default.html
+- _layouts/sections.html
+- assets/js/jekyll-and-plaid.js
+homepage: https://jekyllandplaid.andrew.cmu.edu/
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://github.com/cmu-web/cmu-web-jekyll-and-plaid
+  documentation_uri: https://github.com/cmu-web/cmu-web-jekyll-and-plaid/tree/main/packages/jekyll#readme
+  bug_tracker_uri: https://github.com/cmu-web/cmu-web-jekyll-and-plaid/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Jekyll theme in Carnegie Mellon style
+test_files: []