j1m_toc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf0c1f309fc1c8982b7ef6ffaa685cd7ceecd149
+  data.tar.gz: 60528d02be38368bf5260d506afdb138effc5e40
+SHA512:
+  metadata.gz: 9fbbdefd274c74ad7e48f306711ec51e8484d33ea48e916abf495b442c903158240f448423105d620a671c23d353b259d9cfd3cbd6ad88f56f37bb753650212a
+  data.tar.gz: dad8730924252f3441177884cc0eef683f28f47d5480bb105e890672c5c925004f19be3ded5c40931b5ed3fae5faf54454afd870ae6cb6003dcf2e3910f053ba

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Juergen Adams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# J1mNav
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/j1m_nav`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'j1m_nav'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install j1m_nav
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/j1m_nav.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/_data/modules/default/j1_toc-0.0.1/j1_tocbot.yml

@@ -0,0 +1,165 @@
+# ------------------------------------------------------------------------------
+#   J1: ~/_data/modules/j1_tocbot.yml
+#   J1 Tocbot specific configuration data (TOC Module)
+#
+#   Copyright (C) 2016 Juergen Adams
+#
+#   J1 Template is licensed under the MIT License.
+#   For details, see https://jekyll.one
+#
+# ------------------------------------------------------------------------------
+
+# -------------------------------------------------------------------------
+# GENERAL settings
+#
+# version
+# --------------------------------------------------------------------
+#   Current version of the module
+#
+#   values:                         string
+#   default:                        no defaults
+#
+# log
+# -------------------------------------------------------------------
+#   Setting the log option to true enables the current option 
+#   settings to be written to the JavaScript console so you can 
+#   inspect the settings.
+#
+#   values:                         boolean (true|false)
+#   default:                        false
+#
+version:                            0.0.1
+log:                                false
+
+# -------------------------------------------------------------------------
+# MODULE settings
+#
+# tocSelector
+# -------------------------------------------------------------------
+#   Specifies the <div> element where to render the table of
+#   contents.
+#
+#   type:                           string (HTML class)
+#   values:                         any HTML class
+#   default:                        .js-toc
+#
+# headingSelector
+# -------------------------------------------------------------------
+#   Which headings to grab inside of the contentSelector element
+#   to build the table of contents.
+#
+#   type:                           string (HTML class)
+#   values:                         any HTML heading element class
+#   default:                        "h1, h2, h3"
+#
+# ignoreSelector
+# -------------------------------------------------------------------
+#   Headings that match the ignoreSelector will be skipped
+#   and ignored. Use this HTML class to exclude a heading 
+#   from TOC.
+#
+#   type:                           string (HTML class)
+#   values:                         any HTML class
+#   default:                        .notoc
+#
+# contentSelector
+# -------------------------------------------------------------------
+#  Specifies the <div> element, typiclly your contet area,
+# from which the headings are taken to calculate the TOC.
+#
+#   type:                           string (HTML class)
+#   default:                        .js-toc-content
+#
+# activeLinkColor
+# -------------------------------------------------------------------
+#   Color of the TOC element that is marked as selected 
+#   (active).
+#
+#   type:                           string (color)
+#   default:                        "#204A87"
+#
+# collapseDepth
+# -------------------------------------------------------------------
+#   Specifies how many heading levels should NOT collapsed 
+#   (displayed). For example, a value of 6 will show everything 
+#   (since there are  only 6 heading levels (H1 .. H6) and a 
+#   value of 1 will collapse all. Hidden sections opened and 
+#   closed (accordion effect) as the  content is being scrolled 
+#   down.
+#
+#   type:                           integer ( [1..6] )
+#   default:                        2
+#
+# throttleTimeout
+# -------------------------------------------------------------------
+#   Timeout between events firing to make sure it's not too
+#   rapid (for performance reasons).
+#
+#   type:                           integer
+#   default:                        50
+#
+# scrollOptions
+# -------------------------------------------------------------------
+#   smooth-scroll options object, see more details at:
+#   https://github.com/cferdinandi/smooth-scroll
+#
+#   values
+#
+#     easing
+#     ------------------------------------------------------------
+#       Type|Speed of the scroll effect the heading|section
+#      (of the content) is scrolled to if a toc element has 
+#       been selected:
+#
+#       Linear,                     moves at the same speed from start to finish.
+#       EaseIn,                     gradually increases in speed.
+#       EaseOut,                    gradually decreases in speed.
+#       EaseInOut,                  gradually increases in speed, peaks, and then
+#                                   gradually slows down.
+#
+#       values:                     Linear|
+#                                   easeInQuad|easeInCubic|easeInQuart|easeInQuint
+#                                   easeOutQuad|easeOutCubic|easeOutQuart|easeOutQuint
+#                                   easeInOutQuad|easeInOutCubic|easeInOutQuart|easeInOutQuint
+#
+#       default:                    easeInOutCubic
+#
+#     offset
+#     ------------------------------------------------------------
+#       Amount of space (calculated as pixels) between the top 
+#       of page and the selected table of contents item after
+#       the page has been scrolled.
+#
+#       values:                     integer
+#       default:                    0
+#
+#     speed
+#     ------------------------------------------------------------
+#       Overall time (measured in milliseconds) to complete
+#       the scroll.
+#
+#       values:                     integer
+#       default:                    300
+#
+#     updateURL
+#     ------------------------------------------------------------
+#       ...
+#
+#       values:                     boolean (true|false)
+#       default:                    true
+#
+defaults:
+  tocSelector:                      .js-toc
+  headingSelector:                  "h2, h3, h4, h5"
+  ignoreSelector:                   .notoc
+  contentSelector:                  .js-toc-content
+  activeLinkColor:                  "#204A87"
+  collapseDepth:                    2
+  throttleTimeout:                  50
+  includeHtml:                      false
+  scrollOptions:
+    easing:                         easeInOutCubic
+    offset:                         100
+    speed:                          300
+    updateURL:                      true
+

data/_data/resources/default/j1_toc-0.0.1/resource.yml

@@ -0,0 +1,24 @@
+
+  # -------------------------------------------------------------
+  # Tocbot (TOC Module)
+  #
+  - resource:
+      enabled:                      true
+      version:                      0.0.1
+      id:                           j1_tocbot
+      comment:                      Resources for Tocbot
+      layout:                       [ page, post ]
+      region:                       head
+      required:                     always
+      script_load:                  defer
+      data:
+        css:                        [
+                                      tocbot/css/tocbot
+                                    ]
+        files:                      [
+                                      j1/js/adapters/tocbot.js
+                                    ]
+        js:                         [
+                                      tocbot/js/tocbot
+                                    ]
+        init_function:              J1Tocbot.init

data/assets/themes/j1/j1/js/adapters/tocbot.js

@@ -0,0 +1,161 @@
+---
+---
+
+{% capture j1_cache %}
+
+{% comment %}
+ # -----------------------------------------------------------------------------
+ #  J1: ~/assets/themes/j1/j1/js/adapters/tocbot.js
+ #  JS/Liquid template to create the J1 Adapter for J1 Tocbot
+ #
+ #  Product/Info:
+ #  https://jekyll.one
+ #  https://tscanlin.github.io/tocbot
+ #
+ #  Copyright (C) 2016 Juergen Adams
+ #
+ #  J1 Template is licensed under the MIT License.
+ #  For details, see https://jekyll.one
+ #  Tocbot is licensed under under the MIT License.
+ #  For details, see https://tscanlin.github.io/tocbot
+ #
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+/*
+ # -----------------------------------------------------------------------------
+ #  J1: ~/assets/themes/j1/j1/js/adapters/tocbot.js
+ #  JS Adapter for for J1 Tocbot
+ #
+ #  Product/Info:
+ #  https://jekyll.one
+ #  https://tscanlin.github.io/tocbot
+ #
+ #  Copyright (C) 2016 Juergen Adams
+ #
+ #  J1 Template is licensed under the MIT License.
+ #  For details, see https://jekyll.one
+ #  Tocbot is licensed under under the MIT License.
+ #  For details, see https://tscanlin.github.io/tocbot
+ #
+ # -----------------------------------------------------------------------------
+ #  Adapter generated: {{site.time}}
+ # -----------------------------------------------------------------------------
+*/
+
+{% assign config_tocbot = site.data.modules.j1_tocbot %}
+
+  var J1Tocbot = function () {
+    "use strict";
+    return {
+        // Initialize
+        init: function ( options ) {
+
+          this.settings = $.extend({}, options);
+
+          if ( this.settings.collapseDepth === undefined ) {
+            this.settings.collapseDepth = {{config_tocbot.defaults.collapseDepth}};
+          }
+
+          if ( this.settings.scrollOptions === undefined ) {
+            this.settings.scrollOffset = {{config_tocbot.defaults.scrollOptions.offset}};
+          }
+
+          if ( this.settings.enabled === undefined ) {
+            this.settings.enabled = true;
+          }          
+        
+          if ( this.settings.enabled == true) {      
+                  this.tocbotInit();
+                  this.initAffix();
+                  this.setTop();
+          }          
+
+        },
+        // ---------------------------------------------------------------------
+        // Set Tocbot options
+        // ---------------------------------------------------------------------
+        tocbotInit: function () {
+          tocbot.init({
+            log:                    {{ config_tocbot.log | json }},
+            tocSelector:            {{ config_tocbot.defaults.tocSelector | json }},
+            headingSelector:        {{ config_tocbot.defaults.headingSelector | json }},
+            ignoreSelector:         {{ config_tocbot.defaults.ignoreSelector | json }},
+            contentSelector:        {{ config_tocbot.defaults.contentSelector | json }},
+            collapseDepth:          this.settings.collapseDepth,
+            throttleTimeout:        {{ config_tocbot.defaults.throttleTimeout | json }},
+            smoothScrollOptions:    {
+              easing:               {{ config_tocbot.defaults.scrollOptions.easing | json }},
+              offset:               this.settings.scrollOffset,
+              speed:                {{ config_tocbot.defaults.scrollOptions.speed | json }},
+              updateURL:            {{ config_tocbot.defaults.scrollOptions.updateURL | json }}
+                                    },
+            includeHtml:            "false",
+            headingsOffset:         -1,
+            linkClass:              "toc-link",
+            extraLinkClasses:       "",
+            activeLinkClass:        "is-active-link",
+            listClass:              "toc-list",
+            extraListClasses:       "",
+            isCollapsedClass:       "is-collapsed",
+            collapsibleClass:       "is-collapsible",
+            listItemClass:          "toc-list-item",
+            positionFixedSelector:  "",
+            positionFixedClass:     "is-position-fixed",
+            fixedSidebarOffset:     "auto"
+          });
+
+          if (tocbot.options.log == true) {
+            // Writes all of the current option settings to JS console
+            console.log( tocbot.options );
+          }
+        },
+        // ---------------------------------------------------------------------
+        // Calculate|Set Affix offset Top|Bottom
+        // ---------------------------------------------------------------------
+        // ToDo: Calculation for top-position should use the id #j1-pagehead
+        // instead of the class .j1-pagehead
+        initAffix: function () {
+            var sidebar = $("#j1-sidebar"),
+                header  = $(".j1-pagehead");
+            $(sidebar).affix({
+              offset: {
+                top: function() {
+                  var c = $(sidebar).offset().top,
+                    e = $('.nav').height(),
+                    h = $(header).height(),
+                    z = c - e;
+                    return this.top = c - e
+                  },
+                bottom: function () {
+                  var footer_offset = 100;
+                  return ( this.bottom = $("#j1-footer").outerHeight(true) + footer_offset )
+                }
+              }
+            });
+        },
+        // ---------------------------------------------------------------------
+        // Calculate|Set Top position of the Tocbot menu
+        // ---------------------------------------------------------------------
+        setTop: function () {
+            $(window).scroll(function(event){
+              var navbar    = $("nav.navbar.bootsnav"),
+                  pagehead  = $(".j1-pagehead"),
+                  m         = parseInt(pagehead.css("margin-bottom"), 10),
+                  n         = navbar.outerHeight(),
+                  o         = n + m;
+              if( navbar.hasClass("navbar-fixed")){
+                $("#j1-sidebar.affix").css("top", o);
+              } else {
+                $("#j1-sidebar.affix").css("top", m);
+              }
+            });
+        }
+    }; // end return
+
+  }();
+
+{% endcapture %}
+
+{{ j1_cache | strip_empty_lines }}
+{% assign j1_cache = nil %}

data/assets/themes/j1/tocbot/css/tocbot.css

@@ -0,0 +1,101 @@
+---
+regenerate:             false
+---
+
+{% capture cache %}
+
+/*
+ # -----------------------------------------------------------------------------
+ #  J1: ~/assets/themes/j1/tocbot/css/tocbot.css
+ #  Provides base styles for the toc navigation based on 
+ #  Tim Scanlin's Tocbot
+ #
+ #  Product/Info:
+ #  https://jekyll.one
+ #  https://tscanlin.github.io/tocbot
+ #
+ #  Copyright (C) 2016 Tim Scanlin
+ #  Copyright (C) 2017 Juergen Adams
+ #
+ #  J1 Template is licensed under the MIT License.
+ #  For details, see https://jekyll.one
+ #  Tocbot: Licensed under Open Source Iniative MIT.
+ #  For details, see http://opensource.org/licenses/MIT
+ #
+ # -----------------------------------------------------------------------------
+ #  Test data:
+ #  liquid_var: {{ liquid_var | debug }}
+ #
+ # -----------------------------------------------------------------------------
+ #  CSS file generated: {{site.time}}
+ # -----------------------------------------------------------------------------
+*/
+
+{% assign active_link_color_default = '#204A87' %}
+{% assign config_tocbot             = site.data.modules.j1_tocbot %}
+{% assign active_link_color         = config_tocbot.activeLinkColor %}
+
+
+
+.toc {
+  overflow-y: auto;
+}
+
+/* jadams 2016-10-02: added list-style, list-style-type - set to none */
+.toc  ul {
+  overflow: hidden;
+  position: relative;
+  list-style: none;
+  list-style-type: none !important;
+}
+
+.toc-list {
+  margin: 0;
+  padding-left: 10px;
+}
+
+a.toc-link {
+  color: currentColor;
+  height: 100%;
+  font-size: 14px;
+  text-decoration: none !important;
+}
+
+.is-collapsible {
+  max-height: 1000px;
+  overflow: hidden;
+  transition: all 300ms ease-in-out;
+}
+
+.is-collapsed {
+  max-height: 0;
+}
+
+.is-position-fixed {
+  position: fixed !important;
+  top: 0;
+}
+
+.is-active-link {
+  font-weight: 700;
+}
+
+.toc-link::before {
+  background-color: #EEE;
+  content: ' ';
+  display: inline-block;
+  height: inherit;
+  left: 0;
+  margin-top: -1px;
+  position: absolute;
+  width: 2px;
+}
+
+.is-active-link::before {
+  background-color: {{ active_link_color }};
+}
+
+{% endcapture %}
+
+{{ cache | strip_empty_lines }}
+{% assign cache = nil %}