madness 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 177c0fe6c496b8b07eed2b80140a40db946c8a5af01a1e3d42655e652f3c50b2
-  data.tar.gz: 4e351e74d0a5df4d0111e02ebbe070a4c06cff2fb615b38ed7ef3f1407d3c7fd
+  metadata.gz: fe93b51cce9d5f1e2b37597b86bbcab62273fd2ba588d013308b194bb607d20e
+  data.tar.gz: 4b5e8a9de2af92f7aef8fa86792c8f3156ae9aba4b5049507693c2467dcc439c
 SHA512:
-  metadata.gz: 875ff85eb026afc5146b56dfd213ec5943ff337847d1a0c4f131963f3350c0a8220b516290b4bd56015e4d59b009bb43445f03a323fda03a97bf28cb4baf4d5f
-  data.tar.gz: 8d6dd211a8b35b1a70b74adcf02b178876631fc55d19d07b409947a57420fcdb11b89f1b2ecf7d3a111203e9bdacc3ffefd75d126b45a791d7bbaf44b0bf62ee
+  metadata.gz: 78e416333ece7eb2a236a07593c31f78cb93919f8842b5fede75baff6ae6e07d956ff0b1f30501c1be99416aab4ce036885d49800eeea5d38d5f811745d4c55d
+  data.tar.gz: d237b707b9a7d7a6d9334942a760811f51463a9aa04c007f54789bfa89be08cd04ac6bf7e6f946d86aa45302b50d3d6e4e7c5d4d83ffec88fb4a42c65cdb063c

data/README.md

@@ -61,7 +61,7 @@ searching for local, markdown based documentation directories.
 - Configure with a configuration file or command arguments.
 - Fully customizable theme.
 - Automatic generation of navigation sidebar.
-- Automatic generation of Table of Contents.
+- Automatic generation of Table of Contents (site-wide and inline).
 
 ## Usage
 
@@ -179,8 +179,17 @@ will be automatically added based on the file name.
 
 ## Table of Contents Generation
 
-You can use the `madness --toc FILENAME` command to generate a
-"Table of Contents" markdown file.
+### Site-wide
+
+To generate a Table of Contents file for the entire site (for the directories
+and files), run `madness --toc FILENAME`
+
+### Inline
+
+If you have long markdown documents, and you wish to add an inline Table of
+Contents for them, simply add an HTML comment `<!-- TOC -->` where you want
+the Table of Contents to be generated. The inserted list will only consider
+H2 and H3 headings.
 
 ## Hidden Directories
 

data/lib/madness.rb

@@ -1,4 +1,7 @@
-require 'byebug' if ENV['BYEBUG']
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end
 
 require 'requires'
 

data/lib/madness/document.rb

@@ -99,6 +99,7 @@ module Madness
     def markdown_to_html
       doc = CommonMarker.render_doc markdown, :DEFAULT, [:table]
 
+      replace_toc_marker doc
       add_anchor_ids doc
       html = doc.to_html :UNSAFE
       html = syntax_highlight(html) if config.highlighter
@@ -121,6 +122,34 @@ module Madness
       end
     end
 
+    # Replace <!-- TOC --> with a Table of Contents for the page
+    def replace_toc_marker(doc)
+      toc_marker = doc.find do |node|
+        node.type == :html and node.string_content.include? "<!-- TOC -->"
+      end
+
+      return unless toc_marker
+
+      toc = []
+      doc.walk do |node|
+        next unless node.type == :header
+        level = node.header_level
+        next unless level.between? 2, 3
+        text = node.first_child.string_content
+
+        if level == 2
+          toc << "- [#{text}](##{text.to_slug})"
+        else
+          toc << "  - [#{text}](##{text.to_slug})"
+        end    
+      end
+
+      toc = toc.join "\n"
+      toc = CommonMarker.render_doc toc
+      toc_marker.insert_after toc.first_child
+      toc_marker.insert_after CommonMarker.render_doc("## Table of Contents").first_child
+    end
+
     # If the document does not start with an H1 tag, add it.
     def prepend_h1(html)
       unless html[0..3] == "<h1>"

data/lib/madness/table_of_contents.rb

@@ -5,7 +5,7 @@ module Madness
 
     attr_reader :dir
 
-    def initialize(dir=nil)
+    def initialize(dir = nil)
       @dir = dir || docroot
     end
 
@@ -20,7 +20,7 @@ module Madness
 
   private
 
-    def toc!(path=dir, indent=0)
+    def toc!(path = dir, indent = 0)
       list = Directory.new(path).list
 
       result = []

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.8.3"
+  VERSION = "0.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -327,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Instant Markdown Server