docco 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b669e4e911d124b8dcbf90501aaf0a28b92b7696e74bb6e5b747ea46ac77fdde
-  data.tar.gz: 054efc93cdde11db5134f8ba3de1432db4da5fac5737b60e876411b101e35550
+  metadata.gz: 913faddd18e853e718722f4a62699a7868633009b4484c7b3ec3eefa32a4901a
+  data.tar.gz: ebadd81a683aa2693f2278b006c0ddb5d4ddf89ba8a598f59c69549e5111c8f1
 SHA512:
-  metadata.gz: 3b8989623d87e04d92466047007ac74ec6888669d9ae1e86272bb2287b78f94a7704ff1768f32e4bee529102e1e55f82ee02e4a3688ca16de58fdb9c7adfe5a7
-  data.tar.gz: f3184ef6ce083097aaf8b16a6f5a7445fb8ecff0ec94b8d1a4335966d43782a4db793bb644daf53c736168412a59f963613bdba8e07ad611e7611c67bf0dd4c7
+  metadata.gz: ccb0dc8e64931c6d4bc7c501a9c666f749e5615f746d26a1073c7d35aeea64edb46ae169bccae5f68b6792a91ecdd2bfc7195014ed6e7641ba541b7e7e9179fc
+  data.tar.gz: 4505b54296985860353232647e9b9809ed21203f85466727c8beb18616e14ce276c451255ced6c4765c9c95b7c289865ac5a94bdd9aae23affd60a53a26cee8b

data/lib/docco/parser/content_node.rb

@@ -3,17 +3,14 @@
 module Docco
   class Parser
     class ContentNode
-      def initialize(converter, node)
-        @converter = converter
+      def initialize(node, html)
         @node = node
+        @html = html
       end
 
       def inspect = %(<#{self.class}:#{@node.type} [#{@node.children}]>)
       def section? = false
-
-      def to_html
-        @to_html ||= @converter.convert(@node, 0)
-      end
+      def to_html = @html
     end
   end
 end

data/lib/docco/parser/root.rb

@@ -5,8 +5,7 @@ module Docco
     class Root
       attr_reader :nodes, :level
 
-      def initialize(converter)
-        @converter = converter
+      def initialize
         @nodes = []
         @level = 0
       end
@@ -18,8 +17,8 @@ module Docco
         @nodes << section
       end
 
-      def add_content(node)
-        @nodes << ContentNode.new(@converter, node)
+      def add_content(node, html)
+        @nodes << ContentNode.new(node, html)
       end
 
       def to_html

data/lib/docco/parser/section.rb

@@ -7,9 +7,9 @@ module Docco
 
       attr_reader :id, :options, :nodes
 
-      def initialize(converter:, node:)
-        @converter = converter
+      def initialize(node:, html:)
         @node = node
+        @title_html = html
         @id = node.attr['id']
         @options = node.options
         @nodes = []
@@ -24,20 +24,18 @@ module Docco
         @nodes << section
       end
 
-      def add_content(node)
-        @nodes << ContentNode.new(@converter, node)
+      def add_content(node, html)
+        @nodes << ContentNode.new(node, html)
       end
 
-      def title_html
-        @to_html ||= @converter.convert(@node, 0)
-      end
+      def title_html = @title_html
 
       def title
-        @title ||= title_html.match(HEADING_EXP)[2]
+        @title ||= @title_html.match(HEADING_EXP)[2]
       end
 
       def to_html
-        @nodes.reduce(title_html) do |str, node|
+        @nodes.reduce(+title_html) do |str, node|
           str << "\n" << node.to_html
         end
       end

data/lib/docco/parser.rb

@@ -4,6 +4,31 @@ require 'kramdown'
 
 module Docco
   class Parser
+    # Subclasses Kramdown's HTML converter so we can capture each top-level
+    # child's rendered HTML during a single top-down walk. Overriding only
+    # convert_root lets Kramdown drive the recursion normally (so @stack,
+    # @footnotes, @used_ids, etc. behave as designed); we just replace the
+    # root-level concatenation step with a per-child capture into a hash
+    # keyed by Kramdown element identity.
+    class Renderer < Kramdown::Converter::Html
+      attr_reader :per_element_html
+
+      def initialize(root, options)
+        super
+        @per_element_html = {}
+      end
+
+      def convert_root(el, indent)
+        @stack.push(el)
+        indent += @indent
+        el.children.each do |child|
+          @per_element_html[child] = send(@dispatcher[child.type], child, indent)
+        end
+        @stack.pop
+        ''
+      end
+    end
+
     def initialize(text, input: 'GFM')
       @text = text
       @input = input
@@ -14,26 +39,26 @@ module Docco
     end
 
     private
-    # cc = Kramdown::Converter::Html.send(:new, doc.root, doc.options)
-    # cc.convert doc.children[0], 1 # <= 1 is indent and it's needed
+
     def build
       doc = Kramdown::Document.new(@text, input: @input, auto_ids: true)
-      converter = Kramdown::Converter::Html.send(:new, doc.root, doc.options)
-      root = Root.new(converter)
+      renderer = Renderer.send(:new, doc.root, doc.options)
+      renderer.convert(doc.root)
+
+      root = Root.new
       last_section = root
       levels = Hash.new { |h, k| h[k] = [] }
-      levels[last_section.level] << last_section # root
+      levels[root.level] << root
 
       doc.root.children.each do |child|
+        html = renderer.per_element_html.fetch(child)
         if child.type == :header
-          section = Section.new(converter:, node: child)
+          section = Section.new(node: child, html: html)
           levels[section.level] << section
-          if (parent = levels[section.level - 1].last)
-            parent << section
-          end
+          levels[section.level - 1].last&.<<(section)
           last_section = section
-        else # not a section. Content belonging to last section, or directly to root
-          last_section.add_content child
+        else
+          last_section.add_content(child, html)
         end
       end
 

data/lib/docco/themes/default.css

@@ -19,6 +19,11 @@
     --border-color: #e2e8f0;
     --code-bg: #f1f5f9;
     --code-border: #cbd5e1;
+    /* Code blocks. Text colour must stay legible on --code-block-bg for
+       blocks highlight.js doesn't highlight (unknown language, JS disabled),
+       since those never receive its .hljs class. Defaults match atom-one-dark. */
+    --code-block-bg: #282c34;
+    --code-block-text: #abb2bf;
     --shadow: 0 1px 3px 0 rgba(0, 0, 0, 0.1), 0 1px 2px 0 rgba(0, 0, 0, 0.06);
     --shadow-lg: 0 10px 15px -3px rgba(0, 0, 0, 0.1), 0 4px 6px -2px rgba(0, 0, 0, 0.05);
 }
@@ -435,14 +440,14 @@ pre {
     overflow-x: auto;
     border-radius: 6px;
     box-shadow: var(--shadow);
-    background-color: #282c34;
+    background-color: var(--code-block-bg);
 }
 
 pre code {
     display: block;
     padding: 1.25rem;
     background-color: transparent;
-    color: inherit;
+    color: var(--code-block-text);
     border: none;
     border-radius: 6px;
     line-height: 1.6;
@@ -463,11 +468,18 @@ pre code::-webkit-scrollbar-thumb {
     border-radius: 4px;
 }
 
-pre.mermaid {
-    background: transparent;
-    box-shadow: none;
-    padding: 0;
+/* Mermaid diagrams, rendered by Pele (https://pele.run) */
+.mermaid {
+    margin: 1.5rem 0;
     text-align: center;
+    --pele-bg: var(--content-bg);
+    --pele-fg: var(--text-color);
+    --pele-muted: var(--text-light);
+    --pele-line: var(--secondary-color);
+    --pele-surface: var(--code-bg);
+    --pele-surface-alt: var(--border-color);
+    --pele-border: var(--code-border);
+    --pele-accent: var(--primary-color);
 }
 
 /* Images */

data/lib/docco/themes/default.rb

@@ -52,17 +52,15 @@ module Docco
           </div>
           <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
           <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/ruby.min.js"></script>
-          <script src="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/erb.min.js"></script>
+          <script src="https://cdn.jsdelivr.net/npm/pele@1/dist/pele.global.js"></script>
           <script>
               document.querySelectorAll('pre > code.language-mermaid').forEach((code) => {
-                  const pre = code.parentElement;
-                  const container = document.createElement('pre');
+                  const container = document.createElement('div');
                   container.className = 'mermaid';
-                  container.textContent = code.textContent;
-                  pre.replaceWith(container);
+                  code.parentElement.replaceWith(container);
+                  pele.mount(container, code.textContent);
               });
-              mermaid.initialize({ startOnLoad: false, theme: 'default' });
-              mermaid.run();
               hljs.highlightAll();
           </script>
           <script>

data/lib/docco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docco
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docco
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ismael Celis
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Builds static HTML documentation from a Ruby gem's README
 test_files: []