jekyll-wikibonsai 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c63f70ffb6d84ee8026af1e4c653af39d6ab3b463871d53d2049896ae35f03
-  data.tar.gz: 69c43df63c1dced4f2a6d29e6d15443ebd512ce5dccfc0535916adb37508fb53
+  metadata.gz: 6faa61a7168834eea194802933cb4049c9d9c70db5d0b406cb0696593c71bde0
+  data.tar.gz: 66cc39dae42afca55d2ad8749e186e943e546a61b4d378b09ab43f2d47f4b616
 SHA512:
-  metadata.gz: 79cf66e30df4feda11037b6da491693e399589b7d27d776f3afa8c35be8615b8db53e208c17c1cfd58156db2a24cce5cc0157c1447a22c1b5f51573788bf5da9
-  data.tar.gz: 39938375a325b8abc9857e95d8d01ab040749fc71b3e796f542fdaee1bd00898aed7e61f23aa2e9653d711cddf42bda0aca5c64e5164aebe1bb6c297d684cb79
+  metadata.gz: ca6cccfbbf5dbdf90daff89652346d9b07a2fd5cd179a2cbc129b642287f92d831f06b14817be247a2ee72ea8017b31e10ff1fc5abbb3e9242f1716f5fa3a1fc
+  data.tar.gz: 1936f0e3a057abb329786f7219ad7be9a66d424ca01af3c466329e1197d42c94c95c982f107f2b188aaf01bcbf8e3aeab138812fc672981043885e1da6880c13

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.0.8] - 2023-09-25
+
+- `jekyll-bonsai` -> `jekyll-wikibonsai`.
+- `jekyll-namespaces` -> `jekyll-semtree`.
+

data/README.md

@@ -0,0 +1,57 @@
+# Jekyll-WikiBonsai
+
+[![A WikiBonsai Project](https://img.shields.io/badge/%F0%9F%8E%8B-A%20WikiBonsai%20Project-brightgreen)](https://github.com/wikibonsai/wikibonsai)
+[![Ruby Gem](https://img.shields.io/gem/v/jekyll-wikibonsai)](https://rubygems.org/gems/jekyll-wikibonsai)
+
+<img src="https://github.com/wikibonsai/jekyll-wikibonsai/blob/main/assets/img/bonsai-light.svg" width="300" height="300"/>
+
+💐 Display your [🎋 WikiBonsai](https://github.com/wikibonsai/wikibonsai) digital garden for others.
+
+- Does not currently support CAML primitives (just wikiattrs).
+
+## Features
+
+- [[[Wikirefs]]](https://jekyll-wikibonsai.netlify.app/entry/d1634ef36a/) support.
+- [A semantic tree](https://jekyll-wikibonsai.netlify.app/entry/fa6aa0c597/) support.
+- [Graphs](https://jekyll-wikibonsai.netlify.app/entry/5f44796eaf/)
+
+## Setup
+
+There are multiple ways to utilize this template...
+
+[⚙️ Setup](https://jekyll-wikibonsai.netlify.app/post/0b9db15818/)
+
+### Use
+
+For those interested in getting straight to writing:
+
+[📝 Write](https://jekyll-wikibonsai.netlify.app/post/827a3e6d12/)
+
+### Template
+
+For those that want to write and tinker with the template itself:
+
+[🔍 Tinker](https://jekyll-wikibonsai.netlify.app/post/e7e22a4da8/)
+
+### Code
+
+For those that just want to know how the template works and want to borrow ideas for their own:
+
+[🛠 Code](https://jekyll-wikibonsai.netlify.app/post/2902cedfa6/)
+
+## Plugins
+
+This template depends on the following jekyll plugins:
+
+- WikiBonsai:
+  - [jekyll-wikirefs](https://github.com/wikibonsai/jekyll-wikirefs)
+  - [jekyll-semtree](https://github.com/wikibonsai/jekyll-semtree)
+  - [jekyll-graph](https://github.com/wikibonsai/jekyll-graph)
+- Jekyll:
+  - [jekyll-feed](https://github.com/jekyll/jekyll-feed)
+  - [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
+  - [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)
+- ashmaroli:
+  - [jekyll-data](https://github.com/ashmaroli/jekyll-data)
+- manunamz:
+  - [jekyll-id](https://github.com/manunamz/jekyll-id)

data/_config.yml

@@ -0,0 +1,269 @@
+title: jekyll-wikibonsai
+description: A jekyll theme for semantically inclined digital gardeners.
+author: manunamz
+baseurl: ''
+# url: 'https://jekyll-wikibonsai.netlify.app'
+
+include:
+  - "_pages"
+exclude:
+  - "*.gemspec"
+  - "*.gem"
+  - "Gemfile"
+  - "Gemfile.lock"
+  - "Rakefile"
+  - "README.md"
+  - "CHANGELOG"
+  - "LICENSE"
+
+# how to organize md files:
+# 1. collections_dir: "docs"
+#    from: https://jekyllrb.com/docs/collections/
+# 2. also worth double checking... 
+#     from: https://github.com/eritbh/jekyll-glob
+collections:
+  books:
+    output: true
+  entries:
+    output: true
+  index:
+    output: true
+  states:
+    output: true
+    order:
+      - tags.md
+      - sprout.md
+      - bud.md
+      - bamboo.md
+      - bloom.md
+      - berry.md
+      - fruit.md
+      - melon.md
+      - seed.md
+      - tea.md
+      - pot-bamboo.md
+
+# frontmatter
+# ('type' is explicitly set for search exclusion to work)
+defaults:
+  - 
+    scope:
+      type: "pages"
+    values:
+      type: "pages"
+  - 
+    scope:
+      # path: "_posts/**/*.md"
+      type: "posts"
+    values:
+      type: "posts"
+      layout: "post"
+      permalink: "/post/:id/"
+  - 
+    scope:
+      # path: "_books/**/*.md"
+      type: "books"
+    values:
+      type: "books"
+      layout: "book"
+      permalink: "/book/:id/"
+  - 
+    scope:
+      # path: "_entries/**/*.md"
+      type: "entries"
+    values:
+      type: "entries"
+      layout: "entry"
+      permalink: "/entry/:id/"
+  - 
+    scope:
+      # path: "_index/**/*.md"
+      type: "index"
+    values:
+      type: "index"
+      # layout: "index"
+      # permalink: "/index/:id/"
+  - 
+    scope:
+      # path: "_states/**/*.md"
+      type: "states"
+    values:
+      type: "states"
+      layout: "state"
+      permalink: "/stat/:id/"
+
+sass:
+  sass_dir:          _sass
+  style:            :compressed
+
+enable_mathjax: true
+kramdown:
+  syntax_highlighter: rouge
+  math_engine: mathjax
+
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  startings: []
+  blank_lines: false
+  profile: false 
+
+# 
+# plugins
+# 
+
+# Google Analytics (ip is anonymized by default)
+# ga_tracking: UA-190413040-4
+
+# seo
+# tagline: ""
+# description: ""
+# twitter:
+#   card: summary
+#   username: manunamz
+# author:
+#   twitter: manunamz
+
+# 
+# plugins
+# 
+
+ids:
+  # from: https://github.com/radeno/nanoid.rb#options
+  format:
+    alpha: '1234567890abcdef'
+    size: 10
+semtree:
+  # enabled: true
+  # root: 'i.bonsai'
+  # doctype: 'index'
+  virtual_trunk: true
+  # exclude:
+  #   - "books"
+  #   - "pages"
+  #   - "posts"
+  #   - "states"
+wikirefs:
+  # enabled: true
+  exclude:
+    - "states"
+  css:
+    exclude:
+      # markdown
+      - "footnote"
+      - "reversefootnote"
+      # local-theme-related
+      - "site-nav-btn"
+      - "sem-tag"
+      - "stat-tag"
+      # includes
+      - "anchor-heading"
+      - "toc-list-item-anchor"
+graph:
+  # enabled: true
+  # path:
+  #   assets: "/assets"
+  #   scripts: "/assets/js"
+  exclude:
+    - "books"
+    - "index"
+    - "pages"
+    - "posts"
+    - "states"
+  tree:
+    # enabled: true
+    dag_lvl_dist: 100
+    force:
+      charge: -100
+      strength_x: 0.3
+      x_val: 0.9
+      strength_y: 0.1
+      y_val: 0.9
+  web:
+    # enabled: true
+    # exclude:
+    #   links: true
+    force:
+      charge: -300
+      strength_x: 0.3
+      x_val: 0.75
+      strength_y: 0.1
+      y_val: 0.9
+
+# 
+# includes
+# 
+
+social:
+  connect:
+    enabled: true
+    url:
+      # facebook:
+      github: https://github.com/wikibonsai/jekyll-wikibonsai/
+      # linkedin:
+      # pinterest:
+      # rss:
+      # twitter:
+  share:
+    enabled: true
+    type:
+      - 'email'
+      # - 'facebook'
+      - 'linkedin'
+      # - 'pinterest'
+      - 'twitter'
+
+# 
+# bonsai template configs
+# 
+
+bonsai:
+  debug: false
+  default_theme: "light"
+  date_format: "%Y-%m-%d"
+  svg: 
+    filter: false
+    # smaller: false
+  # site-nav
+  nav:
+    type: "graph"  # may be 'visited' (steps) or 'graph' (bonsai)
+    graph:
+      kind: "tree" # may be 'tree' or 'web'
+    search:
+      enabled: true
+      exclude: []
+    visited:
+      enabled: true
+  # pages
+  home:
+    notable:
+      enabled: true
+      docs:
+        - bonsai.md
+        - wiki-blog.md
+        - feature.md
+        - 2021-11-18-setup.md
+        - 2021-05-11-origin-myth.md
+    recent: 
+      enabled: true
+      cap: 5
+  archive:
+    section:
+      posts: "🫐 🥭 🍈 Fruits"
+      books: "🌰 🍵 🎍 Germs"
+      entries: "🌱 🌿 🎋 🌸 Foliage"
+  # map:
+  recent:
+    cap: 10
+  # documents
+  states:
+    root_path: "_states/tags.md"
+  entries:
+    root_path: "_entries/jekyll-wikibonsai.md"
+    toggles:  # may be 'open' or 'closed'
+      breadcrumb: "open"
+      attr_box: "open"
+      foot_links: "open"
+      foot_tagged: "open"
+    backlinks: true

data/_data/emoji.yml

@@ -0,0 +1,46 @@
+# 
+# the following are emoji buttons
+#  -- there needs to be something here for buttons to work
+# 
+# cookie-consent
+approve:     👍
+consider:    🧐
+disapprove:  👎
+# nav-bar
+colors:      🌈
+## graph
+web:         🕸
+tree:        🌳
+## site-nav
+delete:      🧹
+graph:       🪴
+search:      🔍
+site_nav:    🧭
+visited:     🥾
+## pages
+about:       🪧
+archive:     ⛲️
+bonsai:      🎋
+home:        🏕
+pages:       🗺
+privacy:     🛖
+recent:      🌦
+stat_tags:   🔖
+# entry-only
+breadcrumbs: 🛤
+links:       🚏
+tags:        🧺
+# 
+# the following are informational emojis
+#  -- these are safe to set to "" (empty strings)
+# 
+# social
+connect:     🌊
+share:       🐝  # this is also the emoji for anchor-headings
+# changes
+created:     🌩
+published:   🌤
+updated:     🌧
+deleted:     🌨
+# 404
+missing:     🍂

data/_data/themes.yml

@@ -0,0 +1,145 @@
+- 
+  id: light
+  emoji: ☀️
+  src:
+    favicon: "/assets/img/favicon-light.png"
+    logo: "/assets/img/bonsai-light.svg"
+    nav_burger:
+      base: "/assets/img/nav-base-light.svg"
+      bonsai: "/assets/img/nav-bonsai-light.svg"
+  colors:
+    selection: "#E6E09E"
+    background: "#E4f3EA"
+    text: "#5c5962"
+    text_grey: "#27262b"
+    accent_dark: "#b8d9b8"
+    # accent_dark: "#335C33"
+    accent_light: "#C7E6D3"
+    shadow: "#000"
+    link:
+      web:
+        underline: "#e1e8e3"
+        valid: "#264caf"
+      wiki:
+        underline: "#ede5dd"
+        valid: "#009c7b"
+        invalid: "#959396" 
+  svg:
+    pencil:
+      default: "#5c5962"
+      blue: "#0047aa"
+      green: "#31AF31"
+      red: "#eb3023"
+      yellow: "#dfb600"
+  graph:
+    node:
+      stroke: "#00000000"
+      current: "#F0C61F"
+      missing: "#8C6239"
+      tagged: "#a87f32"
+      unvisited: "#9cbe9c"
+      visited: 
+        color: "#31AF31"
+        glow: "#00000000"
+    link:
+      color: "#8C6239"
+    particles: 
+      color: "#5c5962"
+    text:
+      color: "#5c5962"
+- 
+  id: dark
+  emoji: 🌘
+  src:
+    favicon: "/assets/img/favicon-dark.png"
+    logo: "/assets/img/bonsai-dark.svg"
+    nav_burger:
+      base: "/assets/img/nav-base-dark.svg"
+      bonsai: "/assets/img/nav-bonsai-dark.svg"
+  colors:
+    selection: "#ad9b4b"
+    background: "#27262b"
+    text: "#e1e8e3"
+    text_grey: "#f5f6fa"
+    accent_dark: "#1E1C21"
+    accent_light: "#44434d"
+    shadow: "#fff"
+    link:
+      web:
+        underline: "#44434d"
+        valid: "#89B8D8"
+      wiki:
+        underline: "#44434d"
+        valid: "#A0E4A0"
+        invalid: "#959396"
+  svg:
+    pencil:
+      default: "#e1e8e3"
+      blue: "#0047aa"
+      green: "#31AF31"
+      red: "#eb3023"
+      yellow: "#dfb600"
+  graph:
+    node:
+      stroke: "#44434d"
+      current: "#F0C61F"
+      missing: "#00000000"
+      tagged: "#a87f32"
+      unvisited: "#3e5c50"
+      visited: 
+        color: "#31AF31"
+        glow: "#31AF31"
+    link:
+      color: "#44434d"
+    particles: 
+      color: "#959396"
+    text: 
+      color: "#e6e1e8"
+- 
+  id: star
+  emoji: ✨
+  src:
+    favicon: "/assets/img/favicon-dark.png"
+    logo: "/assets/img/bonsai-star.svg"
+    nav_burger:
+      base: "/assets/img/nav-base-star.svg"
+      bonsai: "/assets/img/nav-bonsai-star.svg"
+  colors:
+    selection: "#f5ec8eA6"
+    background: "#1b2733"
+    text: "#e1e8e3"
+    text_grey: "#f5f6fa"
+    accent_dark: "#151E28"
+    accent_light: "#254756"
+    shadow: "#fff"
+    link:
+      web:
+        underline: "#44434d"
+        valid: "#3D87B8"
+      wiki:
+        underline: "#44434d"
+        valid: "#F3EEBB"
+        invalid: "#959396"
+  svg:
+    pencil:
+      default: "#e1e8e3"
+      blue: "#0047aa"
+      green: "#31AF31"
+      red: "#eb3023"
+      yellow: "#dfb600"
+  graph:
+    node:
+      stroke: "#00000000"
+      current: "#F0C61F"
+      missing: "#586069"
+      tagged: "#0096FF"
+      unvisited: "#2A3D50"
+      visited:
+        color: "#F3F0CF"
+        glow: "#ffffff"
+    link:
+      color: "#254756"
+    particles: 
+      color: "#F3F0CF"
+    text: 
+      color: "#e6e1e8"

data/_includes/anchor-headings.html

@@ -0,0 +1,156 @@
+{% capture headingsWorkspace %}
+  {% comment %}
+    Copyright (c) 2018 Vladimir "allejo" Jimenez
+
+    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.
+  {% endcomment %}
+  {% comment %}
+    Version 1.0.9
+      https://github.com/allejo/jekyll-anchor-headings
+
+    "Be the pull request you wish to see in the world." ~Ben Balter
+
+    Usage:
+      {% include anchor_headings.html html=content anchorBody="#" %}
+
+    Parameters:
+      * html          (string) - the HTML of compiled markdown generated by kramdown in Jekyll
+
+    Optional Parameters:
+      * beforeHeading (bool)   : false  - Set to true if the anchor should be placed _before_ the heading's content
+      * headerAttrs   (string) :  ''    - Any custom HTML attributes that will be added to the heading tag; you may NOT use `id`;
+                                          the `%heading%` and `%html_id%` placeholders are available
+      * anchorAttrs   (string) :  ''    - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`;
+                                          the `%heading%` and `%html_id%` placeholders are available
+      * anchorBody    (string) :  ''    - The content that will be placed inside the anchor; the `%heading%` placeholder is available
+      * anchorClass   (string) :  ''    - The class(es) that will be used for each anchor. Separate multiple classes with a space
+      * anchorTitle   (string) :  ''    - The `title` attribute that will be used for anchors
+      * h_min         (int)    :  1     - The minimum header level to build an anchor for; any header lower than this value will be ignored
+      * h_max         (int)    :  6     - The maximum header level to build an anchor for; any header greater than this value will be ignored
+      * bodyPrefix    (string) :  ''    - Anything that should be inserted inside of the heading tag _before_ its anchor and content
+      * bodySuffix    (string) :  ''    - Anything that should be inserted inside of the heading tag _after_ its anchor and content
+
+    Output:
+      The original HTML with the addition of anchors inside of all of the h1-h6 headings.
+  {% endcomment %}
+
+  {% assign minHeader = include.h_min | default: 1 %}
+  {% assign maxHeader = include.h_max | default: 6 %}
+  {% assign beforeHeading = include.beforeHeading %}
+  {% assign nodes = include.html | split: '<h' %}
+
+  {% capture edited_headings %}{% endcapture %}
+
+  {% for _node in nodes %}
+    {% capture node %}{{ _node | strip }}{% endcapture %}
+
+    {% if node == "" %}
+      {% continue %}
+    {% endif %}
+
+    {% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
+    {% assign headerLevel = nextChar | times: 1 %}
+
+    <!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's see if we need to fix it -->
+    {% if headerLevel == 0 %}
+      <!-- Split up the node based on closing angle brackets and get the first one. -->
+      {% assign firstChunk = node | split: '>' | first %}
+
+      <!-- If the first chunk does NOT contain a '<', that means we've broken another HTML tag that starts with 'h' -->
+      {% unless firstChunk contains '<' %}
+        {% capture node %}<h{{ node }}{% endcapture %}
+      {% endunless %}
+
+      {% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
+      {% continue %}
+    {% endif %}
+
+    {% capture _closingTag %}</h{{ headerLevel }}>{% endcapture %}
+    {% assign _workspace = node | split: _closingTag %}
+    {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+    {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+    {% assign html_id = _idWorkspace[0] %}
+
+    {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+    {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+    <!-- Build the anchor to inject for our heading -->
+    {% capture anchor %}{% endcapture %}
+
+    {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
+      {% assign escaped_header = header | strip_html %}
+
+      {% if include.headerAttrs %}
+        {% capture _hAttrToStrip %}{{ _hAttrToStrip | split: '>' | first }} {{ include.headerAttrs | replace: '%heading%', escaped_header | replace: '%html_id%', html_id }}>{% endcapture %}
+      {% endif %}
+
+      {% capture anchor %}href="#{{ html_id }}"{% endcapture %}
+
+      {% if include.anchorClass %}
+        {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
+      {% endif %}
+
+      {% if include.anchorTitle %}
+        {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', escaped_header }}"{% endcapture %}
+      {% endif %}
+
+      {% if include.anchorAttrs %}
+        {% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', escaped_header | replace: '%html_id%', html_id }}{% endcapture %}
+      {% endif %}
+
+      {% if site.data.emoji.share %}
+        {% capture anchor %}<a {{ anchor }}><i class='anchor-tag'>{{ site.data.emoji.share }}</i></a>{% endcapture %}
+      {% else %}
+        {% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', escaped_header | default: '' }}</a>{% endcapture %}
+      {% endif %}
+
+      <!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
+      {% if beforeHeading %}
+        {% capture anchor %}{{ anchor }} {% endcapture %}
+      {% else %}
+        {% capture anchor %} {{ anchor }}{% endcapture %}
+      {% endif %}
+    {% endif %}
+
+    {% capture new_heading %}
+      <h{{ _hAttrToStrip }}
+        {{ include.bodyPrefix }}
+        {% if beforeHeading %}
+          {{ anchor }}{{ header }}
+        {% else %}
+          {{ header }}{{ anchor }}
+        {% endif %}
+        {{ include.bodySuffix }}
+      </h{{ headerLevel }}>
+    {% endcapture %}
+
+    <!--
+    If we have content after the `</hX>` tag, then we'll want to append that here so we don't lost any content.
+    -->
+    {% assign chunkCount = _workspace | size %}
+    {% if chunkCount > 1 %}
+      {% capture new_heading %}{{ new_heading }}{{ _workspace | last }}{% endcapture %}
+    {% endif %}
+
+    {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
+  {% endfor %}
+{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}