asciidocsy-jekyll-theme 0.3.0.pre.dev

data/assets/js/semantics.js

@@ -0,0 +1,58 @@
+---
+layout: null
+---
+$( document ).ready(function() {
+  /**
+  * controls the
+  * term-popover effect
+  **/
+  if ($('.term').length) { // nothing happens if there are no terms on the page
+    const termsDict = {{ site.data.terms | jsonify }}
+    const icon      = '{{ site.data.theme.semantics.inline.role.term.show.icon.text }}'
+    var termsList   = []
+    /**
+    Scan content for terms and insert data- attrs for
+     popovers
+    **/
+    const asciidoctor = Asciidoctor();
+    $('.term').each(function() {
+      var classes = $(this).attr('class').split(' ');
+      if (classes.length > 1) {
+        var theTerm = termsDict.find(t => t.slug == classes[1]);
+      } else {
+        var theTerm = termsDict.find(t => t.slug == $(this).html().toLowerCase().replace(' ','-'));
+      };
+      if (typeof theTerm !== 'undefined') {
+        if (!termsList.find(t => t.slug == theTerm.slug)) {
+          termsList.push(theTerm);
+        };
+  {% if site.data.theme.semantics.inline.role.term.show.icon %}
+    {% if site.data.theme.semantics.inline.role.term.show.icon.tilt %}
+      {% assign rotate = "fa-rotate-" | append: site.data.theme.semantics.inline.role.term.show.icon.tilt %}
+    {% endif %}
+        $(this).append('<i class="icon ' + icon + ' {{rotate}}">');
+  {% endif %}
+        $(this).attr('data-toggle', 'popover');
+        $(this).attr('data-title', theTerm['term']);
+        $(this).attr('data-content', asciidoctor.convert(theTerm['desc'], {doctype: 'inline'}));
+  {% if site.data.theme.semantics.inline.role.term.show.icon.spin %}
+        $(this).hover(
+          function() {
+            $(this).children('i').addClass('fa-spin')
+          },
+          function() {
+            $(this).children('i').removeClass('fa-spin')
+          });
+  {% endif %}
+      } else {
+        $(this).attr('data-error', 'No term entry found');
+      };
+    });
+    var termsListHTML = '<div class="h5 nav-title terms-nav">Terms in this topic:</div><ul class="page-terms-list nav-list">'
+    termsList.forEach(function(item){
+      termsListHTML += '<li class="list-item nav-item"><a href="/glossary/#' + item.slug + '">' + item.term + '</li>'
+      });
+    termsListHTML += '</ul>';
+    $('#terms-listing').prepend(termsListHTML);
+  };
+});

data/assets/js/tabber.js

@@ -0,0 +1,111 @@
+---
+layout: null
+---
+/**
+ * Convert the div blocks configured with 'tabber-' classes into Bootstrap
+ * tab/pane structures so they can be treated as Bootstrap tab controls.
+ *
+ * See:
+   * https://getbootstrap.com/docs/4.3/components/navs/#javascript-behavior
+   * https://www.w3schools.com/bootstrap/bootstrap_tabs_pills.asp
+ */
+/**
+Liquid generate JSON object of version handlers block
+**/
+{% assign handlers = site.data.theme.versioning.handlers %}
+const tabSets = {
+  {% for ts in handlers %}
+    {% if ts[1].verb == "tab" %}
+    "{{ts[0]}}": {{ ts[1] | jsonify }}
+    {% endif %}
+  {% endfor %}
+}
+
+/**
+Custom jQuery functions
+**/
+// Get the name of a tabset, tab, or pane based on this current element class
+jQuery.fn.getNameByClass = function() {
+  var classes = this.attr("class").split(" ");
+  for (let i = 0; i < classes.length; ++i) {
+    if (classes[i] !== null) {
+      var nameClass = classes[i]
+       .match(/^((tabs|pane|item|link)\-)([a-z_\-0-9]+$)/)
+      if (nameClass != null) {
+        return classes[i].replace(nameClass[0],nameClass[3]);
+        break;
+      };
+    };
+  };
+};
+
+/**
+Document ready
+**/
+$( document ).ready(function() {
+  // Get all the tabbed blocks of the page
+  $(".tabber-tabset").each(function() {
+    $(this).addClass("container")
+    var tabberName = $(this).getNameByClass()
+    var tabSet = tabSets[tabberName]['swap']['opts'];
+    $(this).prepend('<ul class="nav nav-tabs list-' + tabberName + '" role="tablist"></ul>')
+    // Get each tabbed pane
+    $(this).find('.tabber-pane').each(function() {
+      var tabName = $(this).getNameByClass()
+      var tabLabel = tabName.replace("-"," ")
+      $(this).wrap('<div class="tab-pane pane-' + tabName + ' fade" role="tabpanel"></div>')
+      if (tabSet !== null) {
+        // use a match from the tabSet to affix labevar tabLabel = ;
+        tabEntry = tabSet.find(opt => {
+          return opt.slug == tabName
+        });
+        if (typeof tabEntry !== "undefined" && tabEntry['text'] !== null) {
+          tabLabel = tabEntry['text']
+        }
+      };
+      // use the caption IF there is one
+      $(this).find('.title').each(function() {
+        tabLabel = $(this).html();
+        $(this).remove()
+      });
+      $(this).parent().parent('.content')
+      .addClass("tab-content").siblings('.nav.nav-tabs')
+      .append('<li class="nav-item item-' + tabName + '"><a href=".pane-' + tabName + '" class="nav-link link-' + tabName + '" data-toggle="tab" role="tab" aria-selected="false">' + tabLabel + '</a></li>')
+    });
+    // establish defaults
+    var pick = tabSets[tabberName]['swap']['pick'];
+    var nochoice = false;
+    if ( urlParams.has(tabberName) ) {
+      var val = urlParams.get(tabberName)
+    } else if ( $.cookie(tabberName) ) {
+      var val = $.cookie(tabberName)
+    } else if ( typeof tabSets[tabberName]['swap']['pick'] !== 'undefined' ) {
+      var val = tabSets[tabberName]['swap']['pick']
+    }
+    // fallback selection in case default/chosen is not a tab/pane in this tabber
+    $('.tabber-tabset .nav-item:first-child .nav-link').each( function() {
+      $(this).tab('show')
+      $('.pane-' + $(this).getNameByClass() ).each( function() {
+        $(this).addClass("active show").siblings().removeClass("active show")
+      });
+    });
+    // now load the defaults that do exist
+    $('.item-' + val + ' .link-' + val).each( function() {
+      $(this).tab('show')
+    });
+    $('.pane-' + val ).each( function() {
+      $(this).addClass("active show").siblings().removeClass("active show")
+    });
+    $.cookie(tabberName, val)
+  });
+  // additional actions on any tab click event
+  $('.tabber-tabset a[data-toggle="tab"]').on('click', function () {
+    var href = $(this).attr("href")
+    $('.tabber-tabset a[href="' + href + '"]').not($(this)).tab('show')
+    $(href).addClass("active show").siblings().removeClass("active show")
+    $.cookie(
+      $(this).parent().parent().parent().getNameByClass()
+      ,$(this).getNameByClass()
+    )
+  })
+});

data/assets/js/tail.js

@@ -0,0 +1,37 @@
+---
+layout: null
+---
+$( document ).ready(function() {
+
+  // enable bootstrap effecs
+  $('[data-toggle="popover"]').popover({
+      placement : 'top',
+      container : 'body',
+      trigger   : 'hover',
+      delay     : { "show": 300, "hide": 200 },
+      html      : true
+  });
+  $('[data-toggle="tooltip"]').tooltip({
+      placement : 'right',
+      container : 'body',
+      trigger   : 'hover',
+      delay     : { "show": 300, "hide": 200 }
+  });
+
+  // navgoco menu invocation and settings
+  $('#subject-menu').navgoco({
+      accordion: false,
+      openClass: 'open',
+      save: true,
+      cookie: {
+        name: 'navgoco',
+        expires: false,
+        path: '/'
+      },
+      slide: {
+        duration: 400,
+        easing: 'swing'
+      }
+  });
+
+});

data/assets/js/toggler.js

@@ -0,0 +1,50 @@
+---
+---
+/**
+Prepares content for toggling and executes toggle functionality
+**/
+$( document ).ready(function() {
+  {% assign handlers = site.data.theme.versioning.handlers %}
+  const toggleSets = {
+    {%- for ts in handlers %}
+      {%- if ts[1].verb == "toggle" %}
+      "{{ts[0]}}": {{ ts[1] | jsonify }}
+      {%- endif %}
+    {%- endfor %}
+  }
+  var togglesList = [];
+  // hide all elements with a switcher-managed class
+  $('.toggle-handler input').each(function () {
+    var theClass = $("." + $(this).val());
+    $(theClass).hide();
+  });
+  function toggleButton () {
+    console.log($(this).parent())
+    var thisToggle = $(this).parent().parent().attr('name');
+    var $thisInput = $(this)
+    var thisVal    = $thisInput.val();
+    var activeClass = "." + thisVal;
+    $(this).parent().siblings().each( function() {
+      $( '.' +  $(this).find('input').val() ).hide();
+    });
+    $(activeClass).show();
+    $.cookie(thisToggle, thisVal);
+  }
+  $('.toggle-handler input').on('focus', toggleButton)
+  $('.toggle-handler').each( function() {
+    var thisToggle = $(this).attr('name')
+    var pick = toggleSets[thisToggle]['swap']['pick']
+    // Prepare inititial activation, if any
+    if ( urlParams.has(thisToggle) ) {
+      var val = urlParams.get(thisToggle)
+    } else if ( $.cookie(thisToggle) ) {
+      var val = ($.cookie(thisToggle))
+    } else if ( pick != '' && typeof pick !== 'undefined' ) {
+      var val = pick
+    } else {
+      var val = $(this).find('input:first-child').val()
+    }
+    $(this).find('input[value="' + val + '"]').click()
+  });
+  // focus event
+});

data/lib/asciidocsy/data/dependencies.yml

@@ -0,0 +1,142 @@
+- name: FontAwesome
+  slug: fontawesome
+  desc: The iconic font and CSS toolkit.
+  version: 4.7.0
+  original:
+    author: Dave Gandy
+    license: Open Font License
+    uris:
+      site-www: http://fontawesome.io
+      repo-www: https://github.com/FortAwesome/Font-Awesome
+      # repo-uri: # infers git@:github.com:FortAwesome/Font-Awesome.git
+
+- name: Bootstrap
+  slug: bootstrap
+  desc: Twitter's killer HTML/CSS/JS framework
+  version: 4.3.1
+  original:
+    author: Twitter Inc and The Bootstrap Authors
+    license: MIT
+    uris:
+      repo-www: https://github.com/twbs/bootstrap
+      site-www: https://getbootstrap.com/docs/4.3
+  vendor:
+    repo: git@github.com:DocOps/bootstrap.git
+    ref: v4.3.1
+    builds:
+      - # Sass compile command
+    # path: vendor/bootstrap # inferred
+    cdn:
+      - css: https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css
+        integrity: sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh
+      - js: https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js
+        integrity: sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6
+
+- name: jQuery
+  slug: jquery
+  desc: Google's JavaScript framework
+  original:
+    author: OpenJS Foundation and other contributors
+    license: MIT
+    uris:
+      repo-www: https://github.com/jquery/jquery
+      site-www: https://jquery.com
+  vendor:
+    type: static
+    repo: https://github.com/DocOps/jquery
+    path: vendor/jquery
+    ref: 3.3.1
+    migrate:
+      - # jquery and jquery.min files
+
+- name: JQuery Cookie
+  desc: Component for handing cookies
+  note: Used by Navgoco and AsciiDocsy
+  original:
+    author: Klaus Hartl
+    license: MIT
+    uris:
+      repo-www: https://github.com/carhartl/jquery-cookie
+  vendor:
+    source:
+      repo-www: https://github.com/DocOps/jquery-cookie
+      ref: v1.4.1
+
+- name: Navgoco
+  slug: navgoco
+  desc: jQuery collapsible menu
+  original:
+    author: Christodoulos Tsoulloftas
+    license: BSD-3
+    uris:
+      repo-www: https://github.com/tefra/navgoco
+  vendor:
+    source:
+      repo-www: https://github.com/DocOps/navgoco
+      ref: 898fd27
+
+
+- name: Bootstrap TOC
+  slug: bootstrap-ext-toc
+  desc: Unofficial Bootstrap table-of-contents extension
+  original:
+    author: Aidan Feldman
+    license: MIT
+    uris:
+      repo-www: https://github.com/afeld/bootstrap-toc
+      site-www: https://afeld.github.io/bootstrap-toc/
+  vendor:
+    source:
+      repo: git@github.com:DocOps/bootstrap-toc.git
+      ref: v1.0.1
+      cdn:
+    migrate:
+      - # javascript file
+      - # CSS file
+
+- name: AsciidoctorJS
+  slug: asciidoctor-js
+  desc: JavaScript-based AsciiDoc converter
+  original:
+    author: Dan Allen, Guillaume Grossetie, Anthonny Quérouil and the Asciidoctor Project
+    license: MIT
+    uris:
+      repo-www: https://github.com/asciidoctor/asciidoctor.js
+
+- name: Asciidoctor Extensions Lab
+  slug: asciidoctor-extensions
+  desc: Asciidoctor extensions
+  original:
+    author: The Asciidoctor Project
+    license: MIT
+    uris:
+      repo-www: https://github.com/asciidoctor/asciidoctor-extensions-lab
+      docs-www: https://docs.asciidoctor.org/asciidoctor/latest/extensions
+  vendor:
+    source:
+      repo: git@github.com:DocOps/asciidoctor-extensions-lab.git
+      ref: "6975c66"
+
+- name: Asciidoctor Stylesheet Factory
+  slug: asciidoctor-stylesheets
+  desc: Build AsciiDoc-friendly CSS skins from Sass
+  original:
+    author: The Asciidoctor Project
+    license: MIT
+    uris:
+      repo-www: https://github.com/asciidoctor/asciidoctor-stylesheet-factory
+      docs-www: https://asciidoctor.org/docs/produce-custom-themes-using-asciidoctor-stylesheet-factory/
+  vendor:
+    source:
+      repo: git@github.com:DocOps/asciidoctor-stylesheet-factory.git
+      ref: bcb291c
+    compile: # Sass compile command
+
+- name: Docsy Jekyll
+  slug: docsy-jekyll
+  desc: Original Jekyll port of Docsy theme
+  original:
+    author: Vanessa Sochat
+    license: Apache 2.0
+    uris:
+      repo-www: https://github.com/vsoch/docsy-jekyll

data/lib/asciidocsy/data/releases.yml

@@ -0,0 +1,197 @@
+# SUPPORTED product revisions for ASCIIDOCSY
+# LATEST TO OLDEST
+revisions:
+
+  - code: 0.3.0-dev
+    date: 2021-09-12
+
+  - code: 0.2.0
+    date: 2021-07-21
+    memo: |
+      This release introduces a <<#62bf5dd,suite of version-handling features>> as well as a new <<#cced5cd,theme configuration system>> and experimental <<#428a4eb,ReleaseHx>> templates.
+      Several bugfixes are also included.
+    hash: 4e39baa4 # Git hash for the release
+    down: false
+    work:
+      -
+        tick: 10
+        hash: 62bf5dd5ad400011b3239718ef9381b221d1b0c3
+        type: new-feature
+        part: content
+        summ: Added version-handling features and config system
+        tags: [breaking]
+        note: |
+          A full suite of versioning options now enables amending the DOM, swapping tokens, toggling classes, and tabbing panes.
+          Also resolves link:https://github.com/DocOps/asciidocsy-jekyll-theme/issues/9[Issue #9].
+        docs:
+          - xref: /docs/theme/config/versioning
+            text: configuration reference
+      -
+        tick: 41 # ID for the issue ticket
+        hash: cced5cd9f995daf4f0013121f689872c35e5bef9 # Commit hash (7+ chars)
+        type: improvement
+        part: backend
+        summ: Refactored the theme config system, moving from `site` scope to `site.data` scope
+        tags: [breaking]
+        note: |
+          A full suite of versioning options now enables amending the DOM, swapping tokens, toggling classes, and tabbing panes.
+        docs:
+          - xref: /docs/theme/config/
+            text: configuration overview
+          - xref: /docs/theme/config/api-reference
+            text: config API reference
+      -
+        hash: 428a4ebff412d7a988830105eee6a99487b869e7
+        type: new-feature
+        part: content
+        summ: Added ReleaseHx "`release history`" templates
+        note: |
+          AsciiDocsy provides a templates and a YAML format for generating release notes and/or a changelog.
+          If you are reading this as HTML or PDF, you are most likely looking at one such generated release history, for AsciiDocsy itself.
+          Documentation is forthcoming; this feature may change without notice prior to 1.0.
+        tags: [experimental]
+      -
+        hash: 8d7ab51c636e2c7bede590be173ec7c96c45b22d
+        type: new-feature
+        part: docs
+        summ: Started reporting Release History for AsciiDocsy
+        note: |
+          The flagship implementation of the ReleaseHx minimum-viable product is the AsciiDocsy Release Notes and Changelog itself.
+        docs:
+          - text: Release History
+            xref: /docs/theme/history#
+
+      -
+        tick: 4 # ID for the issue ticket
+        hash: a65cfee896b66067fc4dd92ba178167085d55674
+        type: bugfix
+        part: frontend
+        summ: Fixed "`peel`" ("`print-friendly`") function/page-link
+      -
+        tick: 2 # ID for the issue ticket
+        hash: e45db56e8a203ae215ee28152a3c60ea688003c0
+        type: bugfix
+        part: frontend
+        summ: Widened footer, removed unwanted margins
+      -
+        tick: 58 # ID for the issue ticket
+        hash: 9337ab4c1a7a02154ce57d4a720627900e1e3141
+        type: bugfix
+        part: backend
+        summ: Started tracking `Gemfile.lock` in Git (removed from `.gitignore`)
+      -
+        hash: 5a21cd5d3152d2862a8299c0a6a1279096f25e39
+        type: bugfix
+        part: frontend
+        summ: Fix handling of `site.base_url` in head hrefs
+    patches:
+      - code: 0.2.1
+        date: 2021-08-22
+        hash: nohashyetgetahash
+        memo: |
+          Front-end cleanup and dropping the `.html`.
+        work:
+          -
+            hash: e841ea3e561905f9baddffe1d429a78009d6498b
+            tick: 64
+            type: improvement
+            part: backend
+            summ: Stopped Asciidoctor from appending `.html` to xrefs
+          -
+            hash: ff96b2f065070f401b367e180f4eecc3d4a842d6
+            tick: 62
+            type: bugfix
+            part: frontend
+            summ: Added the obligitory Algolia logo to search forms
+          -
+            hash: 750d7875650229e96646532fc922a1a3a28e7269
+            tick: 15
+            type: bugfix
+            part: frontend
+            summ: Stopped the top navbar from scrolling at mobile widths
+          -
+            hash: 3b7510c0f896259f2e3f316d2ed589094a6fb31f
+            tick: 13
+            type: bugfix
+            tags: [deprecation]
+            part: frontend
+            summ: Removed Iconic from skins selection list
+            note: |
+              Because the Iconic skin imposed an ugly box under the page header that was not obviously fixable, Iconic will no longer be an option for users to select in the AsciiDocsy demo site skin changer.
+              The Iconic skin source itself may be removed as early as v0.3.0.
+              Mostly this note was just an excuse to use the `deprecation` tag, also added in this release.
+
+          -
+            hash: d7e9eddc3fee360489df40b70c10764fa5095487
+            tick: 14
+            type: bugfix
+            part: frontend
+            summ: Eliminated scrolling of right sidebar in shorter browsers
+          -
+            hash: 1e3886d223849f6e7ecc978adda210498976fc18
+            tick: 50
+            type: bugfix
+            part: frontend
+            summ: Added optional labels, icons to button-based handlers
+          -
+            hash: a28686e
+            type: bugfix
+            part: frontend
+            summ: Fixed ticket-link template rendering in ReleaseHx
+          -
+            hash: f4346d5
+            type: bugfix
+            part: frontend
+            summ: Fixed Docs link feature in Changelog entries
+            note: |
+              Changelog entries with one and only one doc link will now hyperlink directly to that doc URL.
+              Those with 2 or more doc entries still link to the Release Note entry for the same change, but now all changes with 2+ doc entries will always appear under Release Notes, even if they have no `note` property, so their multiple docs links can appear.
+
+  - code: 0.1.0 # unique revision ID
+    date: 2021-05-19 # release date
+    memo: |
+      This first release of AsciiDocsy has a long way to go, but it is already more mature than many Jekyll docs themes.
+    hash: 884003cfc64754445c71dd5863bd64a54bbf2749
+    work: # NOT YET DELINEATED
+      -
+        hash: 884003cfc64754445c71dd5863bd64a54bbf2749 # Commit hash (7+ chars)
+        type: new-feature #
+        part: backend #
+        summ: Added initial back-end and front-end infrastructure.
+      -
+        hash: 64ad492730b1fcb7d6385bf84721c1ad22ff0d6b
+        type: new-feature
+        part: docs
+        summ: Added initial technical documentation.
+        note: |
+          Basic documentation site uses AsciiDocsy theme under _docs/ directory.
+          Also introduces rudimentary Config API reference platform/DSL.
+        docs:
+          - text: Live Website
+            href: "{{site.deploy_url}}/docs"
+          - text: Source
+            href: "{{site.source_www}}/tree/{{site.source_trunk_branch}}/_docs"
+    patches:
+      - code: 0.1.1
+        date: 2021-05-26
+        hash: 4986070b45d553d1b9c2a5f78df46afd01fb304c
+        memo: |
+          A few promised fixes, nothing backward incompatible.
+        work:
+          - hash: f0a3071bf7d3c9523f0b16a7ad444157d44b885c
+            summ: Split search into 2 indices as was already indicated in UI
+            part: backend
+            type: bugfix
+            note: Both searches were drawing off the same index, so we switched them up into *site search* and *subject search*.
+          - hash: 06b3b93b296b112306fcbcdc010558602617bf16
+            summ: Fixed Navgoco (subject) menu highlights
+            part: frontend
+            type: bugfix
+          - hash: ec35702c953efc0c9d12c2fede52d17905f65207
+            summ: Fixed semantic term icon spin feature
+            part: frontend
+            type: bugfix
+          - hash: a1a61769086268bd38dd8a377b1a6b999e401b2b
+            summ: Improved the install instructions with basic Netlify deployment option
+            part: docs
+            type: improvement

data/lib/asciidocsy/templates/notice-file.txt

@@ -0,0 +1,16 @@
+NOTICE / BILL OF MATERIALS
+====== DO NOT EDIT =======
+This file was automatically generated before release
+from:    lib/data/dependencies.yml
+command: rake build_notice
+
+The AsciiDocsy Jekyll theme acknowledges the following upstream contributions
+packaged in the AsciiDocsy gem:
+{% for dep in data %}
+Project:    {{ dep.name }}
+Author:     {{ dep.original.author }}
+License:    {{ dep.original.license }}
+Source:     {{ dep.original.uris.repo-www }}
+{% endfor %}
+For dependencies not included in the AsciiDocsy gem package,
+ see ./Gemfile.lock in this repository.

data/lib/asciidocsy/version.rb

@@ -0,0 +1,13 @@
+require 'safe_yaml'
+
+SafeYAML::OPTIONS[:deserialize_symbols] = true
+SafeYAML::OPTIONS[:default_mode] = :safe
+
+module AsciiDocsy
+  releases = YAML.load_file('lib/asciidocsy/data/releases.yml')
+  if releases['revisions'][0]['patches']
+    VERSION = releases['revisions'][0]['patches'][0]['code']
+  else
+    VERSION = releases['revisions'][0]['code']
+  end
+end

data/lib/asciidocsy.rb

@@ -0,0 +1 @@
+require 'asciidocsy/version'