jekyll-bonsai 0.0.3

data/_plugins/doc_filters.rb

@@ -0,0 +1,44 @@
+# liquid template to filter for most recently created/edited docs
+require 'time'
+
+module Jekyll
+  module DocFilters
+    def notable(docs)
+      return docs.select { |d| d.data.include?('notable') && (d.data['notable'] == true) }
+    end
+
+    # returns most recently created/updated docs up to the defined 'num'ber.
+    # adds a 'weather' data attribute to render on the page.
+    def recent(docs, num=10)
+      return if docs.nil?
+      num = self.to_integer(num)
+      # sort docs by most recently updated
+      recent_docs = docs.sort_by { |d| d.data['updated'] }.reverse[0..(num - 1)]
+      # assign weather attribute: if 'created' and 'updated' happened on the same day, presume creation status.
+      recent_docs.each do |docs|
+        day_created = Time.at(docs.data['created']).to_date
+        day_updated = Time.at(docs.data['updated']).to_date
+      end
+      return recent_docs
+    end
+
+    def weather(doc)
+      day_created = Time.at(doc['created']).to_date
+      day_updated = Time.at(doc['updated']).to_date
+      return day_created === day_updated ? "🌤" : "🌧"
+    end
+
+    # from: https://github.com/Shopify/liquid/blob/eab13a07d9861a38d993d2749ae25f06ff76426b/lib/liquid/utils.rb#L38
+    def to_integer(num)
+      return num if num.is_a?(Integer)
+      num = num.to_s
+      begin
+        Integer(num)
+      rescue ::ArgumentError
+        raise ArgumentError, "invalid integer"
+      end
+    end
+  end
+end
+  
+Liquid::Template.register_filter(Jekyll::DocFilters)

data/_plugins/prep_entry.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'nanoid'
+require 'time'
+
+class EntryVerificationGenerator < Jekyll::Generator
+  safe true
+  priority :highest
+  
+  def generate(site)
+     #  
+    # init jekyll vars
+     #
+     all_entries = site.collections['entries'].docs
+     # all_pages = site.pages
+     all_docs = all_entries # + all_pages
+
+     link_extension = site.config["permalink"] != "pretty" ? '.html' : ''
+    
+    all_docs.each do |cur_entry|
+      # validation and sanitization
+      prep_entries(site, cur_entry, link_extension)
+    end
+  end
+
+  # verify all entries end with a "\n" so sidenotes works 
+  #   (sidenotes don't detect the last definition if there is no ending "\n").
+  def prep_entries(site, entry, link_extension)
+    # make sure ids are proper nano id format
+    if !(entry.data['id'] =~ /^[1234567890abcdef]{10}$/)
+      entry.data['id'] = Nanoid.generate(size: 10, alphabet: '1234567890abcdef')
+    end
+    # from: https://stackoverflow.com/questions/16235601/what-are-the-steps-to-getting-this-custom-permalink-scheme-in-jekyll
+    # Until Jekyll allows me to use :id, I have to resort to this
+    if link_extension.empty?
+      entry.data['permalink'] = '/entry/' + entry.data['id'] + '/'
+    else
+      entry.data['permalink'] = '/entry/' + entry.data['id'] + link_extension
+    end
+    # sanitize timestamps: remove milliseconds from epoch time
+    entry.data['created'] = Time.at(entry.data['created'].to_s[0..-4].to_i)
+    entry.data['updated'] = Time.at(entry.data['updated'].to_s[0..-4].to_i)
+  end
+end

data/_plugins/sidenote.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class SideNoteGenerator < Generator
+    safe true
+    attr_accessor :md_docs
+
+    ##
+    # parser constants
+    ##
+    # constants are taken from kramdown and baseparser.
+    # (for easier kramdown integration)
+    
+    # from baseparser: https://github.com/ruby/rexml/blob/master/lib/rexml/parsers/baseparser.rb#L36    
+    LETTER = '[:alpha:]'
+    COMBININGCHAR = '' # TODO
+    EXTENDER = ''      # TODO
+    NCNAME_STR= "[#{LETTER}_][-[:alnum:]._#{COMBININGCHAR}#{EXTENDER}]*"
+    UNAME_STR= "(?:#{NCNAME_STR}:)?#{NCNAME_STR}"
+    
+    # from kramdown: https://github.com/gettalong/kramdown
+    # from blank_line.rb
+    BLANK_LINE = /(?>^\s*\n)+/
+    # from eob.rb
+    EOB_MARKER = /^\^\s*?\n/
+    # from kramdown.rb
+    OPT_SPACE = / {0,3}/
+    # Regexp for matching indentation (one tab or four spaces)
+    INDENT = /^(?:\t| {4})/
+    # from extensions.rb
+    ALD_ID_CHARS = /[\w-]/
+    ALD_ANY_CHARS = /\\\}|[^\}]/
+    ALD_ID_NAME = /\w#{ALD_ID_CHARS}*/
+    IAL_BLOCK = /\{:(?!:|\/)(#{ALD_ANY_CHARS}+)\}\s*?\n/
+    IAL_BLOCK_START = /^#{OPT_SPACE}#{IAL_BLOCK}/
+    # from html.rb
+    # Some HTML elements like script belong to both categories (i.e. are valid in block and
+    # span HTML) and don't appear therefore!
+    # script, textarea
+    HTML_SPAN_ELEMENTS = %w[a abbr acronym b big bdo br button cite code del dfn em i img input
+                            ins kbd label mark option q rb rbc rp rt rtc ruby samp select small
+                            span strong sub sup tt u var]
+    # from paragraph.rb
+    LAZY_END_HTML_SPAN_ELEMENTS = HTML_SPAN_ELEMENTS + %w[script]
+    LAZY_END_HTML_START = /<(?>(?!(?:#{LAZY_END_HTML_SPAN_ELEMENTS.join('|')})\b)#{REXML::Parsers::BaseParser::UNAME_STR})/
+    LAZY_END_HTML_STOP = /<\/(?!(?:#{LAZY_END_HTML_SPAN_ELEMENTS.join('|')})\b)#{REXML::Parsers::BaseParser::UNAME_STR}\s*>/m
+    # from markdown.rb
+    # CODEBLOCK_MATCH = /(?:#{BLANK_LINE}?(?:#{INDENT}[ \t]*\S.*\n)+)*/
+    # because `.gsub(INDENT, '')` in footnote.rb
+    # CODEBLOCK_MATCH = /(?:#{BLANK_LINE}?(?:s[ \t]*\S.*\n)+)*/
+    # from codeblock.rb
+    CODEBLOCK_MATCH = /(?:#{BLANK_LINE}?(?:#{INDENT}[ \t]*\S.*\n)+(?:(?!#{IAL_BLOCK_START}|#{EOB_MARKER}|^#{OPT_SPACE}#{LAZY_END_HTML_STOP}|^#{OPT_SPACE}#{LAZY_END_HTML_START})^[ \t]*\S.*\n)*)*/
+
+    # footnotes (for reference)
+    # FOOTNOTE_DEFINITION_START = /^#{OPT_SPACE}\[\^(#{ALD_ID_NAME})\]:\s*?(.*?\n#{CODEBLOCK_MATCH})/
+    # FOOTNOTE_MARKER_START = /\[\^(#{ALD_ID_NAME})\]/
+    ##
+    # constants for local use
+    ##
+    # right
+    RIGHT_SIDENOTE_DEFINITION_START = /^#{OPT_SPACE}\[\>(#{ALD_ID_NAME})\]:\s*?(.*?\n#{CODEBLOCK_MATCH})/
+    RIGHT_SIDENOTE_MARKER_START = /\[\>(#{ALD_ID_NAME})\]/
+    # left
+    LEFT_SIDENOTE_DEFINITION_START = /^#{OPT_SPACE}\[\<(#{ALD_ID_NAME})\]:\s*?(.*?\n#{CODEBLOCK_MATCH})/
+    LEFT_SIDENOTE_MARKER_START = /\[\<(#{ALD_ID_NAME})\]/
+
+    def generate(site)
+
+      # setup markdown docs
+			docs = site.pages + site.docs_to_write
+			@md_docs = docs.filter {|doc| site.find_converter_instance(Jekyll::Converters::Markdown).matches(doc.extname) }
+      
+      link_extension = !!site.config["use_html_extension"] ? '.html' : ''
+   
+      @md_docs.each do |cur_doc|
+        # check for newlines @ eof.
+        #   (kramdown can handle footnotes with no newline, but the regex i'm getting requires a newline after the last footnote to find it.)
+        if cur_doc.content[-1] != "\n"
+          Jekyll.logger.warn "Missing newline at end of file -- this could break sidenotes: ", cur_note.data['title']
+        end    
+        parse_sidenote(cur_doc, "left")
+        parse_sidenote(cur_doc, "right")
+      end
+    end
+
+    # just get tufte-style sidenotes working for now...
+    # if there's time, emulate gwern's method: https://github.com/gwern/gwern.net/blob/9e6893033ec63248b1f0b29df119c40d39a7dcef/css/default.css#L1223
+
+    # mark -> [<left-sidenote], [>right-sidenote]
+    # def -> [<left-sidenote]:, [>right-sidenote]:
+    # `side` should be 'right' or 'left'
+    def parse_sidenote(doc, side)
+      # left v right setup
+      if side == "right"
+        sidenote_def_regex = RIGHT_SIDENOTE_DEFINITION_START
+        # sidenote_mark_regex = RIGHT_SIDENOTE_MARKER_START
+        css_class = "rsn"
+        sn_regex = /\>/
+      elsif side == "left"
+        sidenote_def_regex = LEFT_SIDENOTE_DEFINITION_START
+        # sidenote_mark_regex = LEFT_SIDENOTE_MARKER_START
+        css_class = "lsn"
+        sn_regex = /\</
+      else
+          Jekyll.logger.error "Can't process sidenote that is not either 'right' or 'left'."
+          return
+      end
+      # process sidenotes
+      sidenotes = doc.content.scan(sidenote_def_regex)
+      doc.content.gsub!(sidenote_def_regex, '') # rm sidenote defs from original note.
+      i = 0
+      sidenotes.each do |sidenote|
+        i += 1
+        mark = sidenote[0]
+        definition = sidenote[1]
+        doc.content = doc.content.gsub(
+          /\[#{sn_regex}(#{mark})\]/i,
+          "<label for=\"#{css_class}-#{i}\" class=\"sidenote-toggle sidenote-number\"></label><input type=\"checkbox\" id=\"#{css_class}-#{i}\" class=\"sidenote-toggle\"><span class=\"#{css_class}\">#{definition}</span>"
+        )
+      end
+    end
+  end
+end

data/_plugins/tags.rb

@@ -0,0 +1,52 @@
+# liquid template to filter between semantic and status tags
+module Jekyll
+  module TagFilters
+
+    # filter tags
+    
+    def sem_tags(tags)
+      return if tags.nil?
+      site = @context.registers[:site]
+      sem_tags = []
+      site.collections['entries'].docs.each do |n|
+        tags.each do |t|
+          if n['namespace'] == t
+            sem_tags << { 
+              'tag' => n['title'], 
+              # 'namespace' => n['namespace'], 
+              'url' => n.url 
+            }
+          end
+        end
+      end
+      return sem_tags
+    end
+
+    def stat_tags(tags)
+      return if tags.nil?
+      site = @context.registers[:site]
+      stat_tags = []
+      site.collections['states'].docs.each do |st|
+        tags.each do |t|
+          if st['emoji'] == t
+            stat_tags << {
+              'emoji' => st['emoji'],
+              'url' => st.url
+            }
+          end
+        end
+      end
+      return stat_tags
+    end
+
+    # filter posts
+
+    def sem_tag_posts(namespace)
+      return if namespace.nil?
+      site = @context.registers[:site]
+      return site.posts.docs.select { |p| p['tags'].include?(namespace) }
+    end
+  end
+end
+  
+Liquid::Template.register_filter(Jekyll::TagFilters)

data/_sass/base/_layout.scss

@@ -0,0 +1,54 @@
+//
+// two column layout
+//
+
+.side-bar {
+  z-index: 1;
+  display: flex;
+  flex-wrap: wrap;
+
+  @include mq(md) {
+    width: $nav-width-md;
+    flex-wrap: nowrap;
+    position: fixed;
+    height: 100%;
+  }
+
+  @include mq(lg) {
+    width: $nav-width-lg;
+  }
+}
+
+.main {
+  height: 100%;
+
+  @include mq(md) {
+    max-width: $content-width;
+    margin-left: $nav-width-md;
+  }
+
+  @include mq(lg) {
+    margin-left: $nav-width-lg;
+  }
+}
+
+.main-content-wrap { 
+  @include container;
+  
+  display: flex;
+  flex-direction: column;
+
+  padding-top: $gutter-spacing-sm;
+  padding-bottom: $gutter-spacing-sm;
+
+  min-height: 100vh;
+
+  @include mq(md) {
+    padding-top: $gutter-spacing;
+    padding-bottom: $gutter-spacing;
+  }
+}
+
+.entry-body {
+  padding: $sp-3;
+}

data/_sass/base/_main.scss

@@ -0,0 +1,203 @@
+//
+// Base element style overrides
+//
+// stylelint-disable selector-no-type, selector-max-type
+
+* {
+  box-sizing: border-box;
+}
+
+::selection {
+  color: $grey-dk-100;
+  background: #E6E09E;
+}
+
+html {
+  @include fs-4;
+  scroll-behavior: smooth;
+}
+
+body {
+  font-family: $body-font-family;
+  font-size: inherit;
+  line-height: $body-line-height;
+  color: $body-text-color;
+  background-color: $body-background-color;
+}
+
+ol,
+ul,
+dl,
+pre,
+address,
+blockquote,
+table,
+div,
+hr,
+form,
+fieldset,
+noscript .table-wrapper {
+  margin-top: 0;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  margin-top: 0;
+  margin-bottom: 1em;
+  font-weight: 500;
+  line-height: $body-heading-line-height;
+  color: $body-heading-color;
+}
+
+p {
+  margin-top: 1em;
+  margin-bottom: 1em;
+}
+
+a {
+  color: $link-color;
+  text-decoration: none;
+}
+
+a:not([class]) {
+  text-decoration: none;
+  background-image: linear-gradient($border-color 0%, $border-color 100%);
+  background-repeat: repeat-x;
+  background-position: 0 100%;
+  background-size: 1px 1px;
+
+  &:hover {
+    background-image: linear-gradient(
+      rgba($link-color, 0.45) 0%,
+      rgba($link-color, 0.45) 100%
+    );
+    background-size: 1px 1px;
+  }
+}
+
+code {
+  font-family: $mono-font-family;
+  font-size: 0.75em;
+  line-height: $body-line-height;
+}
+
+figure,
+pre {
+  margin: 0;
+}
+
+li {
+  margin: 0.25em 0;
+}
+
+img {
+  max-width: 100%;
+  height: auto;
+}
+
+hr {
+  height: 1px;
+  padding: 0;
+  margin: $sp-6 0;
+  background-color: $border-color;
+  border: 0;
+}
+
+// wiki-link classes
+
+.invalid-wiki-link {
+  color: $grey-dk-000;
+  background: $invalid-wiki-link-color;
+  cursor: help;
+}
+
+.wiki-link { 
+  color: $wiki-link-color;
+}
+
+.wiki-link-embed {
+  position: relative;
+  border: 1px solid $separator-color;
+  border-radius: 15px;
+  padding: $sp-3;
+
+  .wiki-link-embed-title {
+    @include fs-6;
+    padding-top: $sp-3;
+    padding-left: $sp-3;
+  }
+
+  .wiki-link-embed-content {
+    padding: $sp-3;
+  }
+  
+  .wiki-link-embed-link {
+    position: absolute;
+    top: 1em;
+    right: 1em;
+
+    &::before {
+      content: "🥾";
+    }
+
+    &:hover {
+      filter: drop-shadow(0 0 0.8mm $drop-shadow-brown);
+    }
+  }
+}
+
+.wiki-link-img {
+  width: 50px;
+  height: 50px;
+}
+
+.sem-tag {
+  @include fs-2;
+  padding: $sp-2;
+  border: 1px solid $separator-color;
+  border-radius: 15px;
+  color: $wiki-link-color;
+
+  &:hover {
+    background-color: $base-button-color;
+  }
+}
+
+.stat-tag {
+  filter: drop-shadow(0 0 0.2mm $drop-shadow-green);
+}
+
+.infobox {
+  @include fs-2;
+  float: right;
+  margin-left: $sp-2;
+  margin-right: $sp-2;
+  padding-left: $sp-3;
+  padding-right: $sp-3;
+  padding-top: $sp-3;
+  border: 1px solid $separator-color;
+  border-radius: 15px;
+
+  .title {
+    text-align: center;
+    margin-top: 0;
+  }
+
+  ul {
+    padding: 0 !important;
+    padding-left: $sp-2 !important;
+    padding-right: $sp-2 !important;
+
+    li {
+      list-style-type: none !important;
+  
+      &::before {
+        content: "" !important;
+      }
+    }  
+  }
+}