madness 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b6927fd9ec118b3482a7bcd1d73dad2506ccbe032ea02452131cfeb1f1395fb
-  data.tar.gz: bcb7fcbc8fd2a9bd9e58fa409f6893910901c3334b4f2311f256f36723299bac
+  metadata.gz: c5790a84273b260c95800d1497ce38a0d5e7f2eabe77b8231309ebf70eb7acb4
+  data.tar.gz: 013d8d7b8dd741bc5a03092c58c6326caa2cdf6c82b001be4755615e6184439b
 SHA512:
-  metadata.gz: 0c2ba29929f8c38086a9687752134589a6af6ade4568f5ecc88b94ae1788c84ee9f1b8a1b26b15385337b7f2a1ee8fb167977e108d67a38419a678a45d0a2a81
-  data.tar.gz: 4a5f45398511db07c9cc5ac5228690ee8e37d610fd13fac55c7bb5717d235f1850a65720ffb6ffb1cbbc7d1ca395ef28110714b76656367f98b1cb8e94b7ab17
+  metadata.gz: 942b0408a4ef4e85630703cd31a0c1b0c9d4a5695db685d612cd4280dc01282e725b63629b006dd41abf1ec198ac13df34370444820ea00bdf67c0ffe9c686b4
+  data.tar.gz: 1d0c07859780758c0ea6211ac6f0f62662f49be96adf2d083aba88703148b69e0979caeea5ca47351b5aa775310172533d74ccdb82566013fbd137172de22d9b

data/README.md

@@ -2,12 +2,6 @@
 
 # Madness - Instant Markdown Server
 
-[![Gem Version](https://badge.fury.io/rb/madness.svg)](https://badge.fury.io/rb/madness)
-[![Build Status](https://github.com/DannyBen/madness/workflows/Test/badge.svg)](https://github.com/DannyBen/madness/actions?query=workflow%3ATest)
-[![Maintainability](https://api.codeclimate.com/v1/badges/fa440dc4dbf895734d74/maintainability)](https://codeclimate.com/github/DannyBen/madness/maintainability)
-
----
-
 Madness is a command line server for rendering markdown documents in your
 browser. It is designed to facilitate easy development of internal
 markdown-based documentation sites.
@@ -267,8 +261,32 @@ file or a directory in the same directory as the file itself.
 
 ### Mermaid Diagrams and Charts
 
-When the `mermaid` option is enabled, you may display any mermaid diagram in
-your document by enclosing it in a `<div class='mermaid'>...</div>` block.
+When the `mermaid` option is enabled, you can embed Mermaid diagrams in your
+document using either of the following methods:
+
+1. **Using a `<div>` block with `mermaid` class**:
+
+   ```html
+   <div class="mermaid">
+     graph TD;
+     A-->B;
+     A-->C;
+     B-->D;
+     C-->D;
+   </div>
+   ```
+
+2. **Using a code fence with `mermaid` language specifier**:
+
+   ````markdown
+   ```mermaid
+   graph TD;
+   A-->B;
+   A-->C;
+   B-->D;
+   C-->D;
+   ```
+   ````
 
 ### Table of Contents Generation
 

data/lib/madness/cli.rb

@@ -1,8 +1,8 @@
 require 'mister_bin'
 
 module Madness
-  # The CLI class is used by the bashly binary and forwards incoming CLI
-  # commands to the relevant Bashly::Commands class
+  # The CLI class is used by the madness 'binary' and forwards incoming CLI
+  # commands to the relevant Madness::Commands class
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Madness::VERSION,

data/lib/madness/commands/config.rb

@@ -3,9 +3,9 @@ module Madness
     class Config < Base
       summary 'Manage the madness configuration file'
 
-      usage 'bashly config new'
-      usage 'bashly config show'
-      usage 'bashly config (-h|--help)'
+      usage 'madness config new'
+      usage 'madness config show'
+      usage 'madness config (-h|--help)'
 
       command 'new', 'Create a new .madness.yml configuration file'
       command 'show', 'Show all configuration options'

data/lib/madness/inline_table_of_contents.rb

@@ -36,10 +36,8 @@ module Madness
       level = matches[:level].size - 2
 
       spacer = '  ' * level
-      slug = text.to_slug
+      slug = text.to_slug config.renderer
 
-      # pandoc removes leading numbers and dots from header slugs, we do the same
-      slug = slug.remove(/^[\d\-]+/) if config.renderer == 'pandoc'
       "#{spacer}- [#{text}](##{slug})"
     end
 

data/lib/madness/refinements/string_refinements.rb

@@ -11,8 +11,14 @@ module Madness
         Addressable::URI.escape self
       end
 
-      def to_slug
-        downcase.strip.gsub(/[^[:alnum:]]/, '-').squeeze('-').remove(/(^-|-$)/)
+      def to_slug(renderer = nil)
+        result = downcase.strip
+
+        if renderer == 'pandoc'
+          result.remove(/[^a-z0-9 ]/).tr(' ', '-')
+        else
+          result.gsub(/[^[:alnum:]]/, '-').squeeze('-').remove(/(^-|-$)/)
+        end
       end
 
       # This is here so we can have one place that defines how to convert

data/lib/madness/rendering/pandoc.rb

@@ -6,6 +6,7 @@ module Madness
       include ServerHelper
 
       def render(text)
+        text = process_mermaid_blocks text if config.mermaid
         PandocRuby.new(text, [{ from: :gfm, to: :html }], *options).convert
       end
 
@@ -14,6 +15,12 @@ module Madness
       def options
         @options ||= config.highlighter ? [] : :no_highlight
       end
+
+      def process_mermaid_blocks(text)
+        text.gsub(/```mermaid\s+(.+?)\s+```/m) do
+          "<div class='mermaid'>#{$1.strip}</div>"
+        end
+      end
     end
   end
 end

data/lib/madness/rendering/redcarpet.rb

@@ -36,7 +36,11 @@ module Madness
       end
 
       def handler_class
-        config.highlighter ? HighlightRenderer : ::Redcarpet::Render::HTML
+        if config.mermaid || config.highlighter
+          CustomRenderer
+        else
+          ::Redcarpet::Render::HTML
+        end
       end
     end
   end

data/lib/madness/rendering/redcarpet_custom.rb

@@ -0,0 +1,18 @@
+require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+
+module Madness
+  # Renderer with syntax highlighting support
+  class CustomRenderer < Redcarpet::Render::HTML
+    include Rouge::Plugins::Redcarpet
+
+    def block_code(code, language)
+      if language == 'mermaid'
+        "<div class='mermaid'>#{code}</div>"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = '1.2.2'
+  VERSION = '1.2.4'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -294,7 +294,7 @@ files:
 - lib/madness/rendering/handler.rb
 - lib/madness/rendering/pandoc.rb
 - lib/madness/rendering/redcarpet.rb
-- lib/madness/rendering/redcarpet_highlighter.rb
+- lib/madness/rendering/redcarpet_custom.rb
 - lib/madness/search.rb
 - lib/madness/server.rb
 - lib/madness/server_base.rb
@@ -327,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Instant Markdown Server
 test_files: []

data/lib/madness/rendering/redcarpet_highlighter.rb

@@ -1,10 +0,0 @@
-require 'redcarpet'
-require 'rouge'
-require 'rouge/plugins/redcarpet'
-
-module Madness
-  # Renderer with syntax highlighting support
-  class HighlightRenderer < Redcarpet::Render::HTML
-    include Rouge::Plugins::Redcarpet
-  end
-end