asciidoctor-html 0.1.5 → 0.1.6

data/lib/asciidoctor/html/book.rb

@@ -55,6 +55,7 @@ module Asciidoctor
         @author = ERB::Escape.html_escape opts[:author]
         @date = opts.include?(:date) ? Date.parse(opts[:date]) : Date.today
         @se_id = opts[:se_id]
+        @base_url = opts[:base_url]
         @chapname = opts[:chapname]
         @refs = {} # Hash(docname => Hash(id => reftext))
         @templates = {} # Hash(docname => TData)
@@ -81,11 +82,16 @@ module Asciidoctor
       # - chapters: array of filenames
       # - appendices: array of filenames
       # - outdir: directory to write the converted html files to
-      def write(chapters, appendices, outdir)
+      def write(chapters, appendices, outdir, sitemap: false)
+        needs_sitemap = sitemap && @base_url
+        entries = [] # for sitemap
         read(chapters, appendices).each do |name, html|
-          File.write("#{outdir}/#{name}.html", html)
+          filename = "#{name}.html"
+          File.write("#{outdir}/#{filename}", html)
+          entries << Template.sitemap_entry("#{@base_url}#{filename}") if needs_sitemap
         end
         File.write("#{outdir}/#{SEARCH_PAGE}", search_page(@se_id)) if @se_id
+        File.write("#{outdir}/sitemap.xml", Template.sitemap(entries)) if needs_sitemap
       end
 
       private
@@ -217,10 +223,10 @@ module Asciidoctor
           short_title: @short_title,
           author: @author,
           date: @date,
+          description: doc.attr("description"),
           chapnum: tdata.chapnum,
           chaptitle: tdata.chaptitle,
-          langs: langs(doc),
-          nav: (nav_items.size > 1)
+          langs: langs(doc)
         )
       end
     end

data/lib/asciidoctor/html/cli.rb

@@ -74,7 +74,7 @@ module Asciidoctor
 
       def self.generate_bookopts(config)
         book_opts = {}
-        %i[title short_title author date se_id chapname].each do |opt|
+        %i[title short_title author date se_id base_url chapname].each do |opt|
           key = opt.to_s
           book_opts[opt] = config[key] if config.include?(key)
         end
@@ -91,7 +91,7 @@ module Asciidoctor
         generate_webmanifest outdir, book_opts[:title], book_opts[:short_title]
         book = Book.new book_opts
         puts "Writing book to #{outdir}"
-        book.write config["chapters"], config["appendices"], config["outdir"]
+        book.write config["chapters"], config["appendices"], config["outdir"], sitemap: true
         return unless opts[:watch]
 
         Filewatcher.new("#{config["srcdir"]}/*.adoc").watch do |changes|

data/lib/asciidoctor/html/converter.rb

@@ -4,6 +4,7 @@ require "asciidoctor"
 require_relative "list"
 require_relative "utils"
 require_relative "figure"
+require_relative "table"
 
 module Asciidoctor
   module Html
@@ -33,7 +34,8 @@ module Asciidoctor
         document = node.document
         level = node.level
         show_sectnum = node.numbered && level <= (document.attr("sectnumlevels") || 1).to_i
-        tag_name = %(h#{[level + 2, 6].min})
+        tag_level = [level == 1 ? level + 1 : level + 2, 6].min
+        tag_name = %(h#{tag_level})
         sectnum = show_sectnum ? %(<span class="title-mark">#{node.sectnum ""}</span>) : ""
         content = %(<#{tag_name}>#{sectnum}#{node.title}</#{tag_name}>\n#{node.content})
         Utils.wrap_node content, node, :section
@@ -66,7 +68,8 @@ module Asciidoctor
                      else "exclamation-lg"
                      end
         icon = %(<div class="icon"><i class="bi bi-#{icon_class}"></i></div>)
-        content = %(#{icon}\n#{Utils.display_title node, needs_prefix: false}#{node.content})
+        content = node.blocks? ? node.content : "<p>#{node.content}</p>"
+        content = %(#{icon}\n#{Utils.display_title node, needs_prefix: false}#{content})
         Utils.wrap_id_classes content, node.id, "admonition admonition-#{name}"
       end
 
@@ -129,6 +132,13 @@ module Asciidoctor
         Utils.wrap_node content, node
       end
 
+      def convert_literal(node)
+        nowrap = !(node.document.attr? "prewrap") || (node.option? "nowrap")
+        pre = %(<pre#{%( class="nowrap") if nowrap}>#{node.content}</pre>)
+        title = Utils.display_title(node, needs_prefix: false)
+        Utils.wrap_node "#{title}#{pre}", node
+      end
+
       def convert_open(node)
         collapsible = node.option? "collapsible"
         title = if collapsible
@@ -208,6 +218,34 @@ module Asciidoctor
         end
         super
       end
+
+      def convert_table(node)
+        classes = ["table", node.role].compact
+        classes << "table-striped" if node.option? "striped"
+        classes << "table-bordered" if node.option? "bordered"
+        classes << "table-sm" if node.option? "compact"
+        width_attribute = ""
+        if (autowidth = node.option? "autowidth") && !(node.attr? "width")
+          classes << "table-fit"
+        elsif (tablewidth = node.attr "width")
+          width_attribute = %( width="#{tablewidth}%")
+        end
+        result = [%(<table#{Utils.id_class_attr_str node.id, classes.join(" ")}#{width_attribute}>)]
+        result << %(<caption class="table-title">#{Utils.display_title_prefix node}#{node.title}</caption>)
+        if node.attr("rowcount").positive?
+          result << "<colgroup>"
+          if autowidth
+            result += (Array.new node.columns.size, %(<col>))
+          else
+            node.columns.each do |col|
+              result << (col.option?("autowidth") ? %(<col>) : %(<col style="width:#{col.attr "colpcwidth"}%;">))
+            end
+          end
+          result << "</colgroup>"
+        end
+        result << "#{Table.display_rows(node)}</table>"
+        Utils.wrap_id_classes result.join("\n"), nil, "table-responsive"
+      end
     end
   end
 end

data/lib/asciidoctor/html/figure.rb

@@ -29,9 +29,9 @@ module Asciidoctor
 
       def convert_figlist(node)
         result = node.items.map do |item|
-          %(<li#{Utils.id_class_attr_str item.id}><figure>\n#{item.text}\n</figure></li>)
+          %(<li#{Utils.id_class_attr_str item.id, item.role}><figure>\n#{item.text}\n</figure></li>)
         end
-        content = Utils.wrap_id_classes result.join("\n"), nil, "figlist loweralpha", :ol
+        content = Utils.wrap_id_classes result.join("\n"), nil, "figlist", :ol
         title = %(<div class="figlist-title">#{Utils.display_title_prefix(node)}#{node.title}</div>)
         classes = ["figlist-wrapper", node.role].compact.join(" ")
         Utils.wrap_id_classes %(#{content}#{title}), node.id, classes

data/lib/asciidoctor/html/highlightjs.rb

@@ -88,7 +88,7 @@ module Asciidoctor
             if(text.match(rgx)) {
               text = text.replaceAll(rgx, "");
               el.innerHTML = el.innerHTML.replaceAll(rgx, (match) => {
-                return '<i class="bi bi-' + (match.charCodeAt() - 9311) + '-circle"></i>';
+                return '<i class="hljs-comment bi bi-' + (match.charCodeAt() - 9311) + '-circle"></i>';
               });
             }
           }

data/lib/asciidoctor/html/ref_tree_processor.rb

@@ -91,15 +91,33 @@ module Asciidoctor
       end
 
       def ref_li_mark(mark, depth, style = nil)
-        return "[#{mark}]" if style == "bibliography"
+        return mark.to_s unless style
 
-        depth.even? ? mark.to_s : "(#{mark})"
+        case li_style depth, style
+        when "mark-square-brackets" then "[#{mark}]"
+        when "mark-round-brackets" then "(#{mark})"
+        else mark.to_s
+        end
+      end
+
+      def li_style(depth, list_style)
+        return "mark-square-brackets" if list_style == "bibliography"
+        return "mark-round-brackets" if list_style == "figlist"
+
+        case depth
+        when 1, 3 then "mark-round-brackets"
+        else "mark-dot"
+        end
       end
 
       def offset(list)
         list.attr?("start") ? (list.attr("start").to_i - 1) : 0
       end
 
+      def shift(list)
+        list.attr?("shift") ? list.attr("shift").to_i : 0
+      end
+
       # Finds an anchor at the start of item.text and updates
       # its reftext to that of item's if necessary.
       def register_reftext!(item, reftext)
@@ -121,11 +139,14 @@ module Asciidoctor
           block.set_attr("flat-style", true)
         else
           offset = offset block
+          shift = shift block
           style = block.style
+          d = (style == "figlist" ? 1 : depth) + shift
+          role = li_style d, style
           block.items.each_with_index do |item, idx|
-            d = style == "figlist" ? 1 : depth
             mark = li_mark(d, idx + offset)
             item.set_attr "mark", mark
+            item.role = role
             item_reftext = "#{parent_reftext}#{ref_li_mark mark, d, style}"
             register_reftext! item, item_reftext
           end

data/lib/asciidoctor/html/table.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Html
+    # Helpers for the table conversion
+    module Table
+      def self.display_row(tsec, row)
+        result = ["<tr>"]
+        row.each do |cell|
+          cell_content = if tsec == :head
+                           cell.text
+                         elsif cell.style == :literal
+                           "<pre>#{cell.text}</pre>"
+                         else
+                           cell.content.join "\n"
+                         end
+          cell_tag_name = (tsec == :head || cell.style == :header ? %(th scope="col") : "td")
+          cell_class_attribute = %( class="halign-#{cell.attr "halign"} align-#{cell.attr "valign"}")
+          cell_colspan_attribute = cell.colspan ? %( colspan="#{cell.colspan}") : ""
+          cell_rowspan_attribute = cell.rowspan ? %( rowspan="#{cell.rowspan}") : ""
+          cell_attributes = "#{cell_class_attribute}#{cell_colspan_attribute}#{cell_rowspan_attribute}"
+          result << %(<#{cell_tag_name}#{cell_attributes}>#{cell_content}</#{cell_tag_name}>)
+        end
+        result << "</tr>"
+        result.join "\n"
+      end
+
+      def self.display_rows(node)
+        node.rows.to_h.map do |tsec, rows|
+          next if rows.empty?
+
+          "<t#{tsec}>\n#{rows.map { |row| display_row(tsec, row) }.join("\n")}\n</t#{tsec}>"
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/asciidoctor/html/template.rb

@@ -40,7 +40,7 @@ module Asciidoctor
         <<~HTML
           <main class="main">
           <div class="content-container">
-          <h2>#{nav_text chapnum, chaptitle}</h2>
+          <h1>#{nav_text chapnum, chaptitle}</h1>
           #{content}
           #{footer author, year}
           </div>
@@ -48,6 +48,24 @@ module Asciidoctor
         HTML
       end
 
+      def self.sitemap(entries)
+        <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+
+          #{entries.join "\n"}
+          </urlset>
+        XML
+      end
+
+      def self.sitemap_entry(url)
+        <<~XML
+          <url>
+            <loc>#{url}</loc>
+          </url>
+        XML
+      end
+
       def self.header(title, short_title, nav: true)
         nav_btn = if nav
                     <<~HTML
@@ -70,7 +88,14 @@ module Asciidoctor
       end
 
       def self.footer(author, year)
-        %(<footer class="footer">&#169; #{year} #{author}</footer>\n)
+        <<~HTML
+          <footer class="footer">
+            <div class="footer-left">&#169; #{year} #{author}</div>
+            <div class="footer-right">Built with
+              <a href="https://github.com/ravirajani/asciidoctor-html">asciidoctor-html</a>
+            </div>
+          </footer>
+        HTML
       end
 
       def self.highlightjs(langs)
@@ -79,11 +104,13 @@ module Asciidoctor
         end.join("\n  ")
       end
 
-      def self.head(title, langs)
+      def self.head(title, description, author, langs)
         <<~HTML
           <head>
             <meta charset="utf-8">
             <meta name="viewport" content="width=device-width, initial-scale=1">
+            #{%(<meta name="description" content="#{description}">) if description}
+            #{%(<meta name="author" content="#{author}">) if author}
             <title>#{title}</title>
             <link rel="apple-touch-icon" sizes="180x180" href="#{FAVICON_PATH}/apple-touch-icon.png">
             <link rel="icon" type="image/png" sizes="32x32" href="#{FAVICON_PATH}/favicon-32x32.png">
@@ -102,13 +129,14 @@ module Asciidoctor
       # - title: String
       # - short_title: String
       # - author: String
+      # - description: String
       # - date: Date
-      # - nav: Boolean
       # - chapnum: Int
       # - chaptitle: String
       # - langs: Array[String]
       def self.html(content, nav_items, opts = {})
-        hash_listener = if opts[:nav]
+        nav = (nav_items.size > 1)
+        hash_listener = if nav
                           <<~JS
                             addEventListener('hashchange', function() {
                               collapse = bootstrap.Collapse.getInstance('#sidebar');
@@ -121,10 +149,10 @@ module Asciidoctor
         <<~HTML
           <!DOCTYPE html>
           <html lang="en">
-          #{head opts[:title], opts[:langs]}
+          #{head opts[:title], opts[:description], opts[:author], opts[:langs]}
           <body>
-          #{header opts[:title], opts[:short_title], nav: opts[:nav]}
-          #{sidebar(nav_items) if opts[:nav]}
+          #{header opts[:title], opts[:short_title], nav:}
+          #{sidebar(nav_items) if nav}
           #{main content, opts[:chapnum], opts[:chaptitle], opts[:author], opts[:date].year}
           <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.6/dist/js/bootstrap.bundle.min.js"
                   integrity="sha384-j1CDi7MgGQ12Z7Qab0qlWQ/Qqz24Gc6BM0thvEMVjHnfYGF0rmFCozFSxQBxwHKO"

data/lib/asciidoctor/html/utils.rb

@@ -48,12 +48,8 @@ module Asciidoctor
 
       def self.wrap_node(content, node, tag_name = :div)
         base_class = node.context
-        mod = node.attr?("env") ? node.attr("env") : node.style
-        mod_class = if mod && mod != base_class.to_s
-                      "#{base_class}-#{mod}"
-                    else
-                      ""
-                    end
+        mod = node.style
+        mod_class = "#{base_class}-#{mod}" if mod && mod != base_class.to_s
         classes = [base_class, mod_class, node.role].compact.map(&:to_s).uniq.join(" ").strip
         wrap_id_classes content, node.id, classes, tag_name
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-html
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Ravi Rajani
@@ -100,6 +100,7 @@ files:
 - lib/asciidoctor/html/list.rb
 - lib/asciidoctor/html/popovers.rb
 - lib/asciidoctor/html/ref_tree_processor.rb
+- lib/asciidoctor/html/table.rb
 - lib/asciidoctor/html/template.rb
 - lib/asciidoctor/html/tree_walker.rb
 - lib/asciidoctor/html/utils.rb