paperwork 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88ee93586dfaeee4e866d016e2590a7d0fe48e2401dc5c29f5a9307adfac54c5
-  data.tar.gz: 6e237a15962eec55281ecdd1d93b14a26502d5f53793c7f164e2fdc7780727b3
+  metadata.gz: 6f3fcb5700f4771e6a62a4079c2a87ac9e4a714a0daeb74fb6054a8ca6d05e4a
+  data.tar.gz: 9031d29cd317e2cb03cd92eb32531818cc75f8198917cce31a730f1b3f9667a4
 SHA512:
-  metadata.gz: f30ee505178ea14ff03258a0f807b1b7aacbd2c738f5d025a6e339a78bab132b897e823c0f90278ce0d69e6751df5446207591c35e8b6b7ca7c122a7579df15c
-  data.tar.gz: ed1b2dd3d7713bccb6def5fb4b84c48af51620525960a1ea38db6c5800070c4a29113e34527d2703f80acab7cca6509a30ecb2e0f493ac3951f785dbe0c1f337
+  metadata.gz: 10071a1995561b9e5556e04e817e84ad335389a8b99912487c02ea8999043c2ed356c227d1c7d620cc1a4f7ad1149671d9c859816bc7d22babd28c298df02215
+  data.tar.gz: d77e0e2b16d1cad1e23c0ba6b46dc63a1a62cdd97bf44f76d0d988e143490eaa07b33a612924b149e51c01eacb05e1409fd0e0d444560655c0c85580498d89ee

data/.gitlab-ci.yml

@@ -84,6 +84,5 @@ pages:
     paths:
       - public
   script:
-    - mkdir public
-    - mv .work/doc/build/* public/
+    - mv .work/doc/build public
     - mv .work/coverage public/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paperwork (0.4.0)
+    paperwork (0.5.1)
       listen (~> 3.4.1)
       rake (~> 12.3)
       redcarpet (~> 3.5.0)
@@ -10,38 +10,38 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     byebug (11.1.3)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    ffi (1.14.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    ffi (1.15.5)
     listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     redcarpet (3.5.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.87.1)
@@ -53,15 +53,15 @@ GEM
       rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+    simplecov-html (0.12.3)
     thor (1.1.0)
-    unicode-display_width (1.7.0)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -2,7 +2,9 @@
 title: paperwork
 ---
 
-# paperwork [![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/pipeline.svg)](https://gitlab.com/couchbelag/paperwork/-/commits/master)[![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/coverage.svg)](https://couchbelag.gitlab.io/paperwork/coverage)
+# paperwork
+
+[![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/pipeline.svg)](https://gitlab.com/couchbelag/paperwork/-/commits/master)[![w-10](https://gitlab.com/couchbelag/paperwork/badges/master/coverage.svg)](https://couchbelag.gitlab.io/paperwork/coverage)
 
 
 ### The *paperwork gem* is an aproach to create appealing documentation from markdown documents.

data/lib/paperwork/tasks/middleman_template/lib/doc_renderer.rb

@@ -48,7 +48,7 @@ module DocRenderer
         # end
 
         def paragraph(text)
-            definition_list(text.strip)
+            "<p>#{definition_list(text.strip)}</p>"
         end
 
         def table(header, body)

data/lib/paperwork/tasks/middleman_template/lib/info_helpers.rb

@@ -60,4 +60,10 @@ module InfoHelpers
     def footer_text
         data.paperwork.footer if paperwork?
     end
+
+    def toc?
+        !data.paperwork.config.nil? &&
+            !data.paperwork.config.toc.nil? &&
+            data.paperwork.config.toc
+    end
 end

data/lib/paperwork/tasks/middleman_template/source/javascripts/site.js

@@ -4,5 +4,14 @@ import $ from "jquery";
 import 'popper.js';
 import 'bootstrap';
 import mermaid from "mermaid";
+import {getTableOfContents} from './toc';
 
 mermaid.initialize({startOnLoad:true});
+
+$(()=>{
+  var sidebar = $(".toc.sidebar > ul")
+  var topbar = $(".toc.topbar > ul")
+  var toc = getTableOfContents();
+  toc.insertTo(sidebar);
+  toc.insertTo(topbar);
+});

data/lib/paperwork/tasks/middleman_template/source/javascripts/toc.js

@@ -0,0 +1,64 @@
+import $ from "jquery";
+
+var idCounter = 0;
+
+class Section {
+  constructor(element=null) {
+    this.children = [];
+    this.element = element;
+
+    if (this.element) {
+      this.anchor = "paperwork-h-" + ++idCounter;
+    } else {
+      this.element = $("body");
+    }
+
+    this.element.find(":header").each((index, elem)=>{
+      this.add(new Section($(elem)));
+    });
+  }
+
+  add(childSection) {
+    this.children.push(childSection);
+  }
+
+  id() {
+    return this.anchor;
+  }
+
+  level() {
+    return this.element.prop("tagName").toLowerCase();
+  }
+
+  mark() {
+    if (this.level() != "body") {
+      // create anchor
+      this.element.before("<div id='" + this.id() + "'></div>");
+    }
+    this.children.forEach((child)=>{
+      child.mark();
+    });
+  }
+
+  insertTo(target) {
+    if (this.level() != "body") {
+      // link to anchor
+      target.append("<li class='toc-" + this.level() + "'><a href='#" + this.id() + "'>" + this.text() + "</a></li>");
+    }
+    this.children.forEach((child)=>{
+      child.insertTo(target);
+    });
+  }
+
+  text() {
+    return this.element.text();
+  }
+}
+
+function getTableOfContents() {
+  var toc = new Section();
+  toc.mark();
+  return toc;
+}
+
+export { getTableOfContents };

data/lib/paperwork/tasks/middleman_template/source/layouts/_content.erb

@@ -0,0 +1,6 @@
+<%= partial "layouts/header" %>
+<div class="row">
+    <div class="col">
+        <%= body %>
+    </div>
+</div>

data/lib/paperwork/tasks/middleman_template/source/layouts/_content_with_toc.erb

@@ -0,0 +1,25 @@
+<div class="d-flex">
+    <div class="d-xl-block d-lg-block d-md-block d-none">
+        <%= partial "layouts/toc", locals: {classes: [:sidebar]} %>
+    </div>
+
+    <div>
+        <%= partial "layouts/header" %>
+
+        <div class="row d-xl-none d-lg-none d-md-none ">
+            <div class="col">
+                <%= partial "layouts/toc", locals: {classes: [:topbar]} %>
+            </div>
+        </div>
+
+        <div class="row">
+            <div class="col">
+                <%= body %>
+            </div>
+        </div>
+    </div>
+
+    <div class="v-spacer-2 d-xl-block d-lg-block d-md-block d-sm-none d-xs-none"></div>
+    <div class="v-spacer-2 d-xl-block d-lg-block d-md-none d-sm-none d-xs-none"></div>
+    <div class="v-spacer-3 d-xl-block d-lg-none d-md-none d-sm-none d-xs-none"></div>
+</div>

data/lib/paperwork/tasks/middleman_template/source/layouts/_document.erb

@@ -29,14 +29,21 @@
     <body>
         <%= partial "layouts/navbar" %>
 
+        <% if toc? %>
+        <div class="container-fluid">
+            <div class="row">
+                <div class="col">
+                    <%= partial "layouts/content_with_toc", locals: {body: body} %>
+                </div>
+            </div>
+        <% else %>
         <div class="container">
-            <%= partial "layouts/header" %>
-
             <div class="row">
                 <div class="col">
-                    <%= body %>
+                    <%= partial "layouts/content", locals: {body: body} %>
                 </div>
             </div>
+        <% end %>
 
             <div class="row mt-5 pb-4">
                 <div class="col text-right small border-top">

data/lib/paperwork/tasks/middleman_template/source/layouts/_header.erb

@@ -1,14 +1,14 @@
 <div class="row">
     <div class="col-sm-7 mb-5">
-        <span class="display-2"><%= yield_content :title %></span>
+        <span class="page-title"><%= yield_content :title %></span>
         <br>
-        <span class="display-4"><%= yield_content :subtitle %></span>
+        <span class="page-sub-title"><%= yield_content :subtitle %></span>
     </div>
 
     <div class="col-sm-5">
 
         <div class="row">
-            <div class="col text-right sub-title mb-2">
+            <div class="col text-right page-category mb-2">
                 <%= yield_content :category %>
             </div>
         </div>

data/lib/paperwork/tasks/middleman_template/source/layouts/_toc.erb

@@ -0,0 +1,9 @@
+<%
+    classes ||= []
+    classes << "toc"
+%>
+
+<div class="<%= classes.join(" ") %>">
+    <div class="title">Table of Contents</div>
+    <ul class="list-unstyled"></ul>
+</div>

data/lib/paperwork/tasks/middleman_template/source/stylesheets/site.css.scss

@@ -1,8 +1,16 @@
 @import "../../node_modules/bootstrap/dist/css/bootstrap";
 @import "./bootstrap-icons.css";
 
-.sub-title {
-  font-size: 2.2rem;
+.page-title {
+  font-size: 3rem;
+}
+
+.page-sub-title {
+  font-size: 2rem;
+}
+
+.page-category {
+  font-size: 1.5rem;
 }
 
 $header-siblings-margin: 1rem;
@@ -29,4 +37,39 @@ pre.highlight {
   padding: 0.3rem;
   margin-top: 1rem;
   margin-bottom: 1rem;
-}
+}
+
+.toc {
+  padding-top: 1rem;
+  white-space: nowrap;
+
+  &.sidebar {
+    position: sticky;
+    top: 4rem;
+    margin-right: 5rem;
+    width: 12rem;
+    overflow: hidden;
+    text-overflow: ellipsis;
+  }
+
+  .title {
+    font-weight: bold;
+  }
+
+  @for $i from 1 through 6 {
+    .toc-h#{$i} {
+      font-size: 0.8rem;
+      padding-left: #{($i - 1) * 0.5}rem;
+    }
+  }
+}
+
+
+.d-flex {
+  @for $i from 1 through 5 {
+    .v-spacer-#{$i} {
+      margin-left: #{$i * 2}rem;
+    }
+  }
+}
+

data/lib/paperwork/tasks/middleman_template/webpack.config.js

@@ -2,6 +2,7 @@ const path = require('path');
 
 module.exports = {
     entry: './source/javascripts/site.js',
+    devtool: 'source-map',
 
     resolve: {
         modules: [

data/lib/paperwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paperwork
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
 end

data/paperwork.yml

@@ -8,6 +8,7 @@ navbar:
 
 config:
   name: doc
+  toc: true
   sources:
     - README.md
     - nested_example/navdemo.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperwork
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tobias Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -178,10 +178,14 @@ files:
 - lib/paperwork/tasks/middleman_template/source/fonts/bootstrap-icons.woff2
 - lib/paperwork/tasks/middleman_template/source/images/.keep
 - lib/paperwork/tasks/middleman_template/source/javascripts/site.js
+- lib/paperwork/tasks/middleman_template/source/javascripts/toc.js
+- lib/paperwork/tasks/middleman_template/source/layouts/_content.erb
+- lib/paperwork/tasks/middleman_template/source/layouts/_content_with_toc.erb
 - lib/paperwork/tasks/middleman_template/source/layouts/_document.erb
 - lib/paperwork/tasks/middleman_template/source/layouts/_header.erb
 - lib/paperwork/tasks/middleman_template/source/layouts/_info.erb
 - lib/paperwork/tasks/middleman_template/source/layouts/_navbar.erb
+- lib/paperwork/tasks/middleman_template/source/layouts/_toc.erb
 - lib/paperwork/tasks/middleman_template/source/layouts/layout.erb
 - lib/paperwork/tasks/middleman_template/source/stylesheets/bootstrap-icons.css
 - lib/paperwork/tasks/middleman_template/source/stylesheets/rogue.css.erb