dokno 1.0.0

data/app/views/dokno/articles/_article_form.html.erb

@@ -0,0 +1,60 @@
+<%= render 'dokno/article_formatting' %>
+
+<section class="mb-10">
+
+  <div class="text-2xl mb-5 text-gray-500"><%= article.persisted? ? 'Edit' : 'New' %> Article</div>
+  <h1 class="text-4xl mb-5 leading-tight font-light"><%= article.title %></h1>
+  <hr class="mb-5" />
+
+  <div class="mb-5">
+    <div class="text-lg font-semibold"><label for="slug">Slug</label></div>
+    <input placeholder="Article unique identifier" type="text" name="slug" id="slug" value="<%= article.slug %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 mt-2 w-1/3" />
+    <div class="text-gray-500 mt-2">Unique identifier for this article (required) (2-20 alphanumeric chars)</div>
+  </div>
+
+  <% if Dokno::Category.exists? %>
+    <div class="mb-5">
+      <div class="text-lg font-semibold"><label for="category_id"><%= 'Category'.pluralize article.categories.count %></label></div>
+      <select name="category_code[]" id="category_code" multiple="multiple" size="<%= (cat_count = Dokno::Category.count) <= 4 ? (cat_count + 1).to_s : '5' %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full mt-2 w-full max-w-full">
+        <option></option>
+        <%= Dokno::Category.select_option_markup(selected_category_codes: @category_codes).html_safe %>
+      </select>
+      <div class="text-gray-500 mt-2">
+        If applicable, select one or more categories to which this article will belong (optional). CTRL/CMD to select multiple.
+        Articles will be automatically included in parent categories. Uncategorized articles
+        are displayed on the landing page.
+      </div>
+    </div>
+  <% end %>
+
+  <hr class="mb-5" />
+
+  <div class="mb-5">
+    <div class="text-lg font-semibold"><label for="title">Title</label></div>
+    <input placeholder="Article title" type="text" name="title" id="title" value="<%= article.title %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 mt-2 w-1/2" />
+    <div class="text-gray-500 mt-2">Descriptive article title (required) (5-255 alphanumeric chars)</div>
+  </div>
+
+  <div class="mb-5">
+    <div class="text-lg font-semibold"><label for="summary">Summary</label></div>
+    <input placeholder="Brief article summary" type="text" name="summary" id="summary" value="<%= article.summary %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 mt-2 w-full" />
+    <div class="text-gray-500 mt-2">Brief summary of the described topic (text only)</div>
+  </div>
+
+  <div class="mb-5">
+    <div class="text-lg font-semibold">
+      <label for="markdown">Content</label>
+      <a id="markdown_write_link" href="javascript:;" onclick="writeArticleToggle();" class="float-right hidden"><i data-feather="pen-tool" class="inline"></i> Write</a>
+      <a id="markdown_preview_link" href="javascript:;" onclick="previewArticleToggle();" class="float-right"><i data-feather="eye" class="inline"></i> Preview</a>
+    </div>
+    <textarea placeholder="Full article content" name="markdown" id="markdown" class="rounded text-xl shadow-inner bg-gray-100 p-3 mt-2 w-full" rows="10"><%= article.persisted? ? article.markdown : (article.markdown.presence || @template) %></textarea>
+    <div id="markdown_preview" class="dokno-article-content-markup hidden text-lg overflow-hidden overflow-y-auto rounded p-10 mt-2 bg-gray-100 shadow-inner"></div>
+    <div class="text-gray-500 mt-2">Detailed documentation of the described topic. Basic HTML &amp; <a target="_blank" href="https://commonmark.org/help/" title="Markdown formatting examples">markdown</a> OK.</div>
+  </div>
+
+  <div class="mt-10">
+    <button type="submit" class="bg-gray-700 text-gray-300 hover:bg-gray-900 hover:text-white rounded py-2 px-3 font-bold"><i data-feather="check" class="inline h-5"></i> SAVE ARTICLE</button>
+    <span class="text-lg ml-5"><a class="no-underline" href="<%= article.persisted? ? article_path(article.slug) : root_path %>">Cancel</a></span>
+  </div>
+
+</section>

data/app/views/dokno/articles/edit.html.erb

@@ -0,0 +1,7 @@
+<%= form_with(model: @article, local: true) do |form| %>
+  <% if @article.errors.any? %>
+    <%= render 'partials/form_errors', errors: @article.errors %>
+  <% end %>
+
+  <%= render 'article_form', article: @article %>
+<% end %>

data/app/views/dokno/articles/new.html.erb

@@ -0,0 +1,7 @@
+<%= form_with(url: articles_path) do %>
+  <% if @article.errors.any? %>
+    <%= render 'partials/form_errors', errors: @article.errors %>
+  <% end %>
+  
+  <%= render 'article_form', article: @article %>
+<% end %>

data/app/views/dokno/articles/show.html.erb

@@ -0,0 +1,130 @@
+<%= render 'dokno/article_formatting' %>
+
+<section>
+  <div class="flex">
+    <div id="dokno-article-sidebar" class="w-2/5 pr-10">
+      <div id="article-deprecated-alert" class="<%= 'hidden' if @article.active %> bg-yellow-700 p-4 mb-5 rounded text-lg border-t-4 border-yellow-900 text-white font-base">
+        <i data-feather="alert-circle" class="inline-block mr-2"></i> This article is no longer active
+      </div>
+
+      <h1 class="dokno-article-content-highlight text-4xl mb-10 leading-tight font-light"><%= @article.title %></h1>
+
+      <div>
+        <div class="mb-10 no-print">
+          <button title="Email article" class="bg-gray-600 text-gray-300 hover:text-white rounded mr-3 py-2 px-3 font-bold text-xs" onclick="window.open('mailto:?subject=<%= CGI.escape(@article.title) %>&body=<%= CGI.escape(article_url(@article.slug)) %>');"><i data-feather="send" class="inline h-4"></i> EMAIL THIS</button>
+          <button title="Print article" class="bg-gray-600 text-gray-300 hover:text-white rounded mr-3 py-2 px-3 font-bold text-xs" onclick="window.print();"><i data-feather="printer" class="inline h-4"></i> PRINT THIS</button>
+
+          <% if can_edit? %>
+            <button title="Edit article" class="bg-blue-900 text-gray-300 hover:text-white rounded py-2 px-3 font-bold text-xs" onclick="location.href='<%= edit_article_path(@article.slug) %>';"><i data-feather="edit" class="inline h-4"></i> EDIT THIS</button>
+          <% end %>
+        </div>
+
+        <div class="flex">
+          <div class="no-print w-8"><i data-feather="clock" class="inline-block h-5"></i></div>
+          <div class="w-full">
+            Last updated:<br />
+            <%= time_ago_in_words @article.updated_at %> ago
+            <% if (editor_username = @article.logs.first&.username).present? %>
+              by <%= editor_username %>
+            <% end %>
+          </div>
+        </div>
+
+        <div class="mt-5 flex">
+          <div class="no-print w-8"><i data-feather="eye" class="inline-block h-5"></i></div>
+          <div class="w-full">
+            Views:<br />
+            <%= number_with_delimiter(@article.views, delimiter: ',') %>
+          </div>
+        </div>
+
+        <% if @article.contributors.present? %>
+          <div class="mt-5 flex">
+            <div class="no-print w-8"><i data-feather="user-check" class="inline-block h-5"></i></div>
+            <div class="w-full">
+              Contributors:<br />
+              <%= @article.contributors %>
+            </div>
+          </div>
+        <% end %>
+
+        <% if @article.reading_time.present? %>
+          <div class="mt-5 flex">
+            <div class="no-print w-8"><i data-feather="watch" class="inline-block h-5"></i></div>
+            <div class="w-full">
+              Reading time:<br />
+              <%= @article.reading_time %>
+            </div>
+          </div>
+        <% end %>
+
+        <div class="mt-5 flex">
+          <div class="no-print w-8"><i data-feather="link" class="inline-block h-5"></i></div>
+          <div class="w-full">
+            Permalink:<br />
+            <a class="inline-block mt-1 -ml-2 px-2 py-1 bg-blue-100 rounded" title="Copy to clipboard" href="javascript:;" onclick="copyToClipboard('<%= @article.permalink(request.base_url) %>');"><%= @article.permalink(request.base_url) %></a>
+          </div>
+        </div>
+
+        <% if can_edit? %>
+          <div class="mt-5 flex">
+            <div class="no-print w-8"><i data-feather="crosshair" class="inline-block h-5"></i></div>
+            <div class="w-full">
+              Unique slug:<br />
+              <a class="inline-block mt-1 -ml-2 px-2 py-1 bg-blue-100 rounded" title="Copy to clipboard" href="javascript:;" onclick="copyToClipboard('<%= j @article.slug %>');"><%= @article.slug %></a>
+
+              <% if (old_slugs = @article.article_slugs).present? %>
+                <div class="text-gray-500 mt-5">
+                  Editor note:<br />
+                  This article is still accessible via previous
+                  <%= 'slug'.pluralize(old_slugs.count) %>
+                  <%= old_slugs.map(&:slug).reject { |slug| slug == @article.slug }.to_sentence %>
+                </div>
+              <% end %>
+            </div>
+          </div>
+        <% end %>
+
+        <% if @article.categories.exists? %>
+          <div class="mt-5 flex">
+            <div class="no-print w-8"><i data-feather="folder" class="inline-block h-5"></i></div>
+            <div class="w-full">
+              <%= 'Category'.pluralize @article.categories.count %>:<br />
+              <%= @article.category_name_list.split(':').last.html_safe %>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    </div>
+    <div id="dokno-article-content" class="dokno-article-content-highlight w-3/5">
+      <% if @article.summary.present? %>
+        <div class="text-2xl mb-8 text-gray-700 font-light"><%= simple_format @article.summary %></div>
+      <% end %>
+
+      <% if @article.markdown.present? %>
+        <div id="dokno-article-content-markup" class="dokno-article-content-markup text-gray-800 font-light mb-10 bg-gray-100 p-10 rounded">
+          <%= @article.markdown_parsed %>
+        </div>
+      <% end %>
+
+      <% if @article.summary.blank? && @article.markdown.blank? %>
+        <div class="mb-10">No content</div>
+      <% end %>
+
+      <% if can_edit? %>
+        <div class="no-print">
+          <hr class="mt-5" />
+          <div class="mt-10 text-right">
+            <button title="Deactivate article" id="article-deactivate-button" class="bg-yellow-700 text-gray-300 hover:text-white rounded mr-3 py-2 px-3 font-bold text-xs <% if !@article.active %>hidden<% end %>" onclick="deactiveArticle('<%= @article.slug %>');"><i data-feather="sunset" class="inline h-4"></i> DEACTIVATE THIS</button>
+            <button title="Re-activate article" id="article-activate-button" class="bg-green-700 text-gray-300 hover:text-white rounded mr-3 py-2 px-3 font-bold text-xs <% if @article.active %>hidden<% end %>" onclick="activeArticle('<%= @article.slug %>');"><i data-feather="sunrise" class="inline h-4"></i> RE-ACTIVATE THIS</button>
+            <button title="Permanently delete article" class="bg-red-700 text-gray-300 hover:text-white rounded py-2 px-3 font-bold text-xs" onclick="deleteArticle('<%= @article.id %>');"><i data-feather="trash" class="inline h-4"></i> DELETE THIS</button>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</section>
+
+<% if @search_term.present? %>
+  <script>highlightTerm(['<%= j @search_term.strip %>'], 'dokno-article-content-highlight');</script>
+<% end %>

data/app/views/dokno/categories/_category_form.html.erb

@@ -0,0 +1,33 @@
+<section class="mb-10">
+
+  <div class="text-2xl mb-5 text-gray-500"><%= category.persisted? ? 'Edit' : 'New' %> Category</div>
+  <hr class="mb-5" />
+
+  <div class="mb-5">
+    <div class="text-lg font-semibold"><label for="name">Category Name</label></div>
+    <input type="text" name="name" id="name" value="<%= category.name %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 mt-2 w-1/3" />
+    <div class="text-gray-500 mt-2">Unique name for this category (required)</div>
+  </div>
+
+  <% if Dokno::Category.exists? %>
+    <div class="mb-5">
+      <div class="text-lg font-semibold"><label for="parent_category_code">Parent Category</label></div>
+      <select name="parent_category_code" id="parent_category_code" class="rounded text-xl shadow-inner bg-gray-100 p-2 mt-2 w-1/2 max-w-full">
+        <option></option>
+        <%= Dokno::Category.select_option_markup(selected_category_codes: [@parent_category_code], exclude_category_id: category.id).html_safe %>
+      </select>
+      <div class="text-gray-500 mt-2 w-1/2">
+        The existing category to which this category belongs.
+        <% if (article_count = category.articles.count).positive? %>
+          There <%= article_count > 1 ? "are #{article_count} articles" : 'is an article' %> currently in this category.
+          Changing the parent category will move <%= article_count > 1 ? 'them' : 'it' %> as well.
+        <% end %>
+      </div>
+    </div>
+  <% end %>
+
+  <div class="mt-10">
+    <button type="submit" class="bg-gray-700 text-gray-300 hover:bg-gray-900 hover:text-white rounded py-2 px-3 font-bold"><i data-feather="check" class="inline h-5"></i> SAVE CATEGORY</button>
+    <span class="text-lg ml-5"><a class="no-underline" href="<%= category.persisted? ? "#{root_path}?id=#{category.id}" : root_path %>">Cancel</a></span>
+  </div>
+</section>

data/app/views/dokno/categories/edit.html.erb

@@ -0,0 +1,7 @@
+<%= form_with(model: @category, local: true) do |form| %>
+  <% if @category.errors.any? %>
+    <%= render 'partials/form_errors', errors: @category.errors %>
+  <% end %>
+
+  <%= render 'category_form', category: @category %>
+<% end %>

data/app/views/dokno/categories/index.html.erb

@@ -0,0 +1,96 @@
+
+<div class="flex items-center mb-10">
+  <% if Dokno::Category.exists? %>
+    <div class="w-1/2 pr-5">
+      <select name="category" id="category" size="1" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full max-w-full" onchange="location.href='<%= article_index_path %>' + this.value + '?search_term=' + elem('#search_term').value + '&order=<%= @order %>';">
+        <option value="">Select a category</option>
+        <%= Dokno::Category.select_option_markup(selected_category_codes: [@category&.code]).html_safe %>
+      </select>
+    </div>
+  <% end %>
+  <div class="w-<%= Dokno::Category.exists? ? '1/2 pl-5' : 'full' %>">
+    <%= form_with(url: article_index_path(@category&.code), method: :get) do %>
+      <input type="hidden" name="order" value="<%= @order %>">
+      <input placeholder="Search article content, titles, and slugs" type="text" name="search_term" id="search_term" value="<%= @search_term %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full" />
+    <% end %>
+  </div>
+</div>
+
+<% if @articles.blank? %>
+
+  <section class="border-t border-gray-300 py-10 text-xl">
+    <% if Dokno::Category.exists? %>
+      <% if @search_term.present? %>
+        No articles found <% if @category.present? %>in this category<% end %> matching the given search criteria
+      <% elsif @category.present? %>
+        No articles found in this category
+      <% else %>
+        No uncategorized articles
+      <% end %>
+    <% elsif can_edit? %>
+      <a href="<%= new_category_path(@category&.id) %>">Add your first category</a>
+    <% end %>
+  </section>
+
+<% else %>
+
+  <div id="dokno-article-list-controls-top" class="flex mb-10">
+    <div class="w-2/3">
+      <%= render 'partials/pagination' %>
+    </div>
+    <div class="w-1/3 text-right">
+      <i data-feather="corner-right-down" class="h-5 inline-block" title="Sort order"></i>
+      <a class="ml-3 pb-1 <%= 'border-b-2 border-blue-900' if @order == 'updated' %>" href="?search_term=<%= CGI.escape @search_term.to_s %>&order=updated">Updated</a>
+      <a class="ml-3 pb-1 <%= 'border-b-2 border-blue-900' if @order == 'newest' %>" href="?search_term=<%= CGI.escape @search_term.to_s %>&order=newest">Newest</a>
+      <a class="ml-3 pb-1 <%= 'border-b-2 border-blue-900' if @order == 'views' %>" href="?search_term=<%= CGI.escape @search_term.to_s %>&order=views">Views</a>
+      <a class="ml-3 pb-1 <%= 'border-b-2 border-blue-900' if @order == 'alpha' %>" href="?search_term=<%= CGI.escape @search_term.to_s %>&order=alpha">Title</a>
+    </div>
+  </div>
+
+  <div id="dokno-article-list">
+    <% @articles.each_with_index do |article, i| %>
+      <section class="border-t border-gray-300 py-10 text-xl flex">
+        <div class="w-1/3 pr-10">
+          <div class="flex">
+            <div class="no-print w-10 text-gray-300"><i data-feather="chevron-right" class="inline-block"></i></div>
+            <div class="w-full">
+              <a class="" href="<%= article_path article.slug %>?search_term=<%= @search_term %>" title="View article"><%= article.title %></a>
+            </div>
+          </div>
+        </div>
+        <div class="dokno-article-summary w-2/3 <% unless article.active %>text-gray-500 italic<% end %>">
+          <% unless article.active %>
+            <div class="bg-yellow-700 p-4 mb-5 rounded text-lg border-t-4 border-yellow-900 text-white font-base not-italic">
+              <i data-feather="alert-circle" class="inline-block"></i> This article is no longer active
+            </div>
+          <% end %>
+
+          <span class="dokno-article-content-highlight"><%= article.summary.presence || 'No summary provided' %></span>
+
+          <div class="text-base mt-2">
+            <div class="text-gray-500"><%= article.category_name_list(context_category_id: @category&.id, order: @order, search_term: @search_term) %></div>
+
+            <% if @order == 'views' %>
+              <div class="text-gray-500">Viewed <%= number_with_delimiter(article.views, delimiter: ',') %> <%= 'time'.pluralize(article.views) %></div>
+            <% elsif @order == 'updated' %>
+              <div class="text-gray-500">Last updated <%= time_ago_in_words article.updated_at %> ago</div>
+            <% elsif @order == 'newest' %>
+              <div class="text-gray-500">Added <%= time_ago_in_words article.created_at %> ago</div>
+            <% end %>
+          </div>
+        </div>
+      </section>
+    <% end %>
+  </div>
+
+  <div id="dokno-article-list-controls-bottom" class="flex mt-10">
+    <div class="w-2/3">
+      <%= render 'partials/pagination' %>
+    </div>
+    <div class="w-1/3 text-right"></div>
+  </div>
+<% end %>
+
+<% if @search_term.present? %>
+  <script>highlightTerm(['<%= j @search_term.strip %>'], 'dokno-article-content-highlight');</script>
+<% end %>

data/app/views/dokno/categories/new.html.erb

@@ -0,0 +1,7 @@
+<%= form_with(url: categories_path) do %>
+  <% if @category.errors.any? %>
+    <%= render 'partials/form_errors', errors: @category.errors %>
+  <% end %>
+  
+  <%= render 'category_form', category: @category %>
+<% end %>

data/app/views/layouts/dokno/application.html.erb

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= Dokno.config.app_name %> KNOWLEDGEBASE</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "dokno/application", media: "all" %>
+  <%= javascript_include_tag 'dokno/application' %>
+
+  <script>
+    var dokno__base_path = '<%= root_path %>';
+  </script>
+</head>
+<body class="bg-white font-sans font-light subpixel-antialiased">
+
+  <nav id="dokno-nav-container" class="bg-blue-900 text-white py-10 px-16 text-lg">
+    <div class="flex items-center m-auto w-full max-w-screen-xl">
+      <div class="w-1/3">
+        <a href="<%= root_path %>">
+          <span class="font-semibold uppercase"><%= Dokno.config.app_name %> KNOWLEDGEBASE</span>
+        </a>
+      </div>
+      <div class="w-2/3 text-right">
+        <% if can_edit? %>
+          <% if action_name != 'new' %>
+            <button title="Add a new article" class="bg-gray-700 text-gray-300 hover:text-white hover:bg-gray-900 rounded ml-3 py-2 px-3 font-bold text-base" onclick="location.href='<%= new_article_path %>/?category_code=<%= @category&.code %>';"><i data-feather="plus-circle" class="inline h-5"></i> ARTICLE</button>
+            <button title="Add a new category" class="bg-gray-700 text-gray-300 hover:text-white hover:bg-gray-900 rounded ml-3 py-2 px-3 font-bold text-base" onclick="location.href='<%= new_category_path %>/?parent_category_code=<%= @category&.code %>';"><i data-feather="plus-circle" class="inline h-5"></i> CATEGORY</button>
+          <% end %>
+
+          <% if @category&.persisted? && action_name != 'edit' %>
+            <button title="Edit this category" class="bg-gray-700 text-gray-100 hover:text-white hover:bg-gray-900 rounded ml-3 py-2 px-3 font-bold text-base" onclick="location.href='<%= edit_category_path(@category) %>';"><i data-feather="edit" class="inline h-5"></i> CATEGORY</button>
+          <% end %>
+        <% end %>
+
+        <% if action_name != 'edit' %>
+          <button class="bg-green-700 text-gray-300 hover:text-white hover:bg-green-800 rounded ml-3 py-2 px-3 font-bold text-base" onclick="window.open('/');"><i data-feather="log-out" class="inline h-5"></i> GO TO APP</button>
+        <% end %>
+      </div>
+    </div>
+  </nav>
+
+  <main class="py-10 px-16">
+    <% if @article.blank? && (@category.blank? || @search_term.present?) %>
+      <div class="text-center m-auto mb-10 w-full max-w-screen-xl">
+        <% if @search_term.present? %>
+          <div class="text-gray-600 text-2xl uppercase">
+            <%= (article_count = @articles.count).positive? ? "#{article_count} #{'article'.pluralize(article_count)}" : 'No articles' %>
+            found containing the search term
+            <div class="text-4xl leading-tight"><span class="font-serif">&ldquo;</span> <%= @search_term %> <span class="font-serif">&rdquo;</span> </div>
+          </div>
+        <% else %>
+          <div class="text-gray-600 text-2xl">
+            Browse or search
+            <% if (article_count = Dokno::Article.count) > 1 %>
+              <%= number_with_delimiter(article_count, delimiter: ',') %> articles in
+            <% end %>
+            the
+          </div>
+          <div class="text-gray-800 text-4xl leading-tight uppercase"><%= Dokno.config.app_name %> knowledgebase</div>
+        <% end %>
+      </div>
+    <% end %>
+
+    <div id="dokno-content-container" class="w-full max-w-screen-xl m-auto print-this">
+      <%= yield %>
+    </div>
+  </main>
+
+  <footer id="dokno-footer-container">
+    <% if @article.present? && action_name == 'show' %>
+      <div id="dokno-article-log-container" data-category-id="<%= @category&.id %>" data-article-id="<%= @article&.id %>">
+        <%= render 'partials/logs', category: @category, article: @article %>
+      </div>
+    <% end %>
+
+
+    <div class="py-10 px-16 text-gray-400 bg-blue-900">
+      <div class="w-full max-w-screen-xl m-auto flex">
+        <div class="w-1/2">
+          <a target="_blank" href="https://github.com/cpayne624/dokno" title="Knowledgebase">dokno</a>
+        </div>
+        <div class="w-1/2 text-right">
+          <% if user.present? %>
+            <span title="<%= Dokno.config.app_name %> Authenticated User" class="mr-10">
+              <i data-feather="user<%= '-check' if can_edit? %>" class="inline-block h-5"></i> <span class="text-white"><%= username %></span>
+              (<%= can_edit? ? 'Editor' : 'Read Only' %>)
+            </span>
+          <% end %>
+
+          <a href="/" target="_blank" title="Go to the app" class="font-semibold"><%= Dokno.config.app_name %></a>
+        </div>
+      </div>
+    </div>
+
+  </footer>
+
+  <%= javascript_include_tag 'init' %>
+</body>
+</html>