madness 0.9.9 → 1.0.0.rc1

data/app/styles/_rouge.scss

@@ -0,0 +1,213 @@
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight .cm {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cp {
+  color: #999999;
+  font-weight: bold;
+}
+.highlight .c1 {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cs {
+  color: #999999;
+  font-weight: bold;
+  font-style: italic;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .err {
+  color: #a61717;
+  background-color: #e3d2d2;
+}
+.highlight .gd {
+  color: #000000;
+  background-color: #ffdddd;
+}
+.highlight .ge {
+  color: #000000;
+  font-style: italic;
+}
+.highlight .gr {
+  color: #aa0000;
+}
+.highlight .gh {
+  color: #999999;
+}
+.highlight .gi {
+  color: #000000;
+  background-color: #ddffdd;
+}
+.highlight .go {
+  color: #888888;
+}
+.highlight .gp {
+  color: #555555;
+}
+.highlight .gs {
+  font-weight: bold;
+}
+.highlight .gu {
+  color: #aaaaaa;
+}
+.highlight .gt {
+  color: #aa0000;
+}
+.highlight .kc {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kd {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kn {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kp {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kr {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kt {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kv {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .mf {
+  color: #009999;
+}
+.highlight .mh {
+  color: #009999;
+}
+.highlight .il {
+  color: #009999;
+}
+.highlight .mi {
+  color: #009999;
+}
+.highlight .mo {
+  color: #009999;
+}
+.highlight .m, .highlight .mb, .highlight .mx {
+  color: #009999;
+}
+.highlight .sa {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .sb {
+  color: #d14;
+}
+.highlight .sc {
+  color: #d14;
+}
+.highlight .sd {
+  color: #d14;
+}
+.highlight .s2 {
+  color: #d14;
+}
+.highlight .se {
+  color: #d14;
+}
+.highlight .sh {
+  color: #d14;
+}
+.highlight .si {
+  color: #d14;
+}
+.highlight .sx {
+  color: #d14;
+}
+.highlight .sr {
+  color: #009926;
+}
+.highlight .s1 {
+  color: #d14;
+}
+.highlight .ss {
+  color: #990073;
+}
+.highlight .s, .highlight .dl {
+  color: #d14;
+}
+.highlight .na {
+  color: #008080;
+}
+.highlight .bp {
+  color: #999999;
+}
+.highlight .nb {
+  color: #0086B3;
+}
+.highlight .nc {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .no {
+  color: #008080;
+}
+.highlight .nd {
+  color: #3c5d5d;
+  font-weight: bold;
+}
+.highlight .ni {
+  color: #800080;
+}
+.highlight .ne {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nf, .highlight .fm {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nl {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nn {
+  color: #555555;
+}
+.highlight .nt {
+  color: #000080;
+}
+.highlight .vc {
+  color: #008080;
+}
+.highlight .vg {
+  color: #008080;
+}
+.highlight .vi {
+  color: #008080;
+}
+.highlight .nv, .highlight .vm {
+  color: #008080;
+}
+.highlight .ow {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .o {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .w {
+  color: #bbbbbb;
+}
+.highlight {
+  background-color: #f8f8f8;
+}

data/app/styles/_scrollbar.scss

@@ -0,0 +1,9 @@
+// Scrollbar
+::-webkit-scrollbar {
+  width: 6px;
+  height: 6px;
+}
+::-webkit-scrollbar-thumb {
+  background: #ccc;
+  -webkit-border-radius: 3px;
+}

data/app/styles/main.scss

@@ -1,7 +1,7 @@
 @import "manifest";
 
 body {
-  max-width: 1300px;
+  max-width: 1400px;
   margin: 0 auto;
 }
 
@@ -20,7 +20,7 @@ body {
   @include desktop {
     &.with-sidebar {
       min-height: 100vh;
-      margin-left: 250px;
+      margin-left: 300px;
     }
   }
   

data/lib/madness/command_line.rb

@@ -66,17 +66,8 @@ module Madness
       config.toc          = args['--toc']  if args['--toc']
       config.auth         = args['--auth'] if args['--auth']
       config.auth_realm   = args['--auth-realm'] if args['--auth-realm']
-
-      config.auto_h1      = false   if args['--no-auto-h1']
-      config.auto_nav     = false   if args['--no-auto-nav']
-      config.sidebar      = false   if args['--no-sidebar']
-      config.highlighter  = false   if args['--no-syntax']
-      config.line_numbers = false   if args['--no-line-numbers']
-      config.copy_code    = false   if args['--no-copy-code']
-      config.shortlinks   = true    if args['--shortlinks']
-      config.open         = true    if args['--open']
-
-      config.theme = File.expand_path(args['--theme'], config.path) if args['--theme']
+      config.open         = true if args['--open']
+      config.theme        = File.expand_path(args['--theme'], config.path) if args['--theme']
     end
 
     # Generate index and toc, if requested by the user.

data/lib/madness/docopt.txt

@@ -28,37 +28,6 @@ Options:
     Set server listen address.
     (Config option: bind, default: 0.0.0.0)
 
-  --no-auto-h1
-    By default, if a markdown document does not start with an H1 caption,
-    it will be added automatically based on the file name. To disable this
-    behavior, use --no-auto-h1.
-    (Config option: auto_h1)
-
-  --no-syntax
-    Disable code syntax highlighting.
-    (Config option: highlighter)
-
-  --no-line-numbers
-    Disable line numbering for syntax highlighter.
-    (Config option: line_numbers)
-
-  --no-copy-code
-    Disable copy to cliboard icon for code snippets.
-    (Config option: copy_code)
-
-  --no-sidebar
-    Disable sidebar navigation.
-    (Config option: sidebar)
-
-  --no-auto-nav
-    Disable automatic generation of footer navigation for folder README 
-    files.
-    (Config option: auto_nav)
-
-  --shortlinks
-    Enable support for [[Short Links]].
-    (Config option: shortlinks)
-
   --theme FOLDER
     Use a custom theme. FOLDER is either absolute or relative to the main
     documentation path.
@@ -86,13 +55,10 @@ Options:
 Examples:
   madness
   madness docs
-  madness docs --no-auto-h1 -p 4567
+  madness docs -p 4567
   madness docs --open
-  madness --no-sidebar --no-auto-nav
   madness --toc "Table of Contents.md" --and-quit
   madness --auth user:secret --port 4000
   madness --theme _mytheme
   madness create config
   madness create theme
-
-

data/lib/madness/document.rb

@@ -1,8 +1,5 @@
-require 'commonmarker'
-require 'coderay'
-
 module Madness
-  # Handle a single markdown document.
+  # Handle a single document path.
   class Document
     include ServerHelper
     using StringRefinements
@@ -18,12 +15,7 @@ module Madness
 
     # Return the HTML for that document
     def content
-      @content ||= content!
-    end
-
-    # Return the HTML for that document, force re-read.
-    def content!
-      %i[empty missing].include?(type) ? "<h1>#{title}</h1>" : markdown_to_html
+      @content ||= %i[empty missing].include?(type) ? "<h1>#{title}</h1>" : markdown.to_html
     end
 
   private
@@ -65,108 +57,11 @@ module Madness
     end
 
     def markdown
-      @markdown ||= pre_process_markdown
-    end
-
-    def pre_process_markdown
-      result = File.read file
-      result = evaluate_shortlinks result if config.shortlinks
-      result
-    end
-
-    def doc
-      @doc ||= CommonMarker.render_doc markdown, :DEFAULT, [:table]
-    end
-
-    # Convert markdown to HTML, with some additional processing:
-    # 1. Add anchors to headers
-    # 2. Syntax highilghting
-    # 3. Prepend H1 if needed
-    def markdown_to_html
-      replace_toc_marker
-      prepend_h1 if config.auto_h1
-      add_anchor_ids
-      html = doc.to_html :UNSAFE
-      html = syntax_highlight(html) if config.highlighter
-      html
-    end
-
-    # Add anchors with IDs before all headers
-    def add_anchor_ids
-      doc.walk do |node|
-        if node.type == :header
-          anchor = CommonMarker::Node.new(:inline_html)
-
-          next unless node.first_child.type == :text
-
-          anchor_id = node.first_child.string_content.to_slug
-          anchor.string_content = "<a id='#{anchor_id}'></a>"
-          node.prepend_child anchor
-        end
-      end
+      @markdown ||= MarkdownDocument.new(markdown_text, title: title)
     end
 
-    # Replace <!-- TOC --> with a Table of Contents for the page
-    def replace_toc_marker
-      toc_marker = doc.find do |node|
-        node.type == :html and node.string_content.include? '<!-- TOC -->'
-      end
-
-      return unless toc_marker
-
-      toc_marker.insert_after document_toc
-      toc_marker.insert_after CommonMarker.render_doc('## Table of Contents').first_child
-    end
-
-    # Replace [[link]] with [link](link)
-    def evaluate_shortlinks(raw)
-      raw.gsub(/\[\[([^\]]+)\]\]/) { "[#{$1}](#{$1.to_href})" }
-    end
-
-    # Returns a UL object containing the document table of contents
-    def document_toc
-      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
-        spacer = '  ' * (level - 1)
-        toc << "#{spacer}- [#{text}](##{text.to_slug})"
-      end
-
-      toc = toc.join "\n"
-      CommonMarker.render_doc(toc).first_child
-    end
-
-    # If the document does not start with an H1 tag, add it.
-    def prepend_h1
-      return unless doc.first_child
-      return if (doc.first_child.type == :header) && (doc.first_child.header_level == 1)
-
-      h1 = CommonMarker.render_doc("# #{title}").first_child
-      doc.first_child.insert_before h1
-    end
-
-    # Apply syntax highlighting with CodeRay. This will parse for any
-    # <code class='LANG'> sections in the HTML, pass it to CodeRay for
-    # highlighting.
-    # Since CodeRay adds another HTML escaping, on top of what RDiscount
-    # does, we unescape it before passing it to CodeRay.
-    #
-    # Open StackOverflow question:
-    # http://stackoverflow.com/questions/37771279/prevent-double-escaping-with-coderay-and-rdiscount
-    def syntax_highlight(html)
-      line_numbers = config.line_numbers ? :table : nil
-      opts = { css: :style, wrap: nil, line_numbers: line_numbers }
-      html.gsub(%r{<code class="language-(.+?)">(.+?)</code>}m) do
-        lang = $1
-        code = $2
-        code = CGI.unescapeHTML code
-        CodeRay.scan(code, lang).html opts
-      end
+    def markdown_text
+      @markdown_text ||= File.read file
     end
 
     def md_file?

data/lib/madness/highlight_renderer.rb

@@ -0,0 +1,10 @@
+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

data/lib/madness/markdown_document.rb

@@ -0,0 +1,103 @@
+require 'redcarpet'
+
+module Madness
+  # Handle a pure markdown document.
+  class MarkdownDocument
+    include ServerHelper
+    using StringRefinements
+
+    attr_reader :markdown, :title
+
+    def initialize(markdown, title: nil)
+      @markdown = markdown
+      @title = title || ''
+    end
+
+    def text
+      @text ||= begin
+        result = markdown
+        result = parse_toc(result) if config.auto_toc
+        result = parse_shortlinks(result) if config.shortlinks
+        result = prepend_h1(result) if config.auto_h1
+        result
+      end
+    end
+
+    def to_html
+      @to_html ||= Redcarpet::Markdown.new(redcarpet_renderer, redcarpet_options).render text
+    end
+
+  private
+
+    def parse_toc(input)
+      input.gsub '<!-- TOC -->', toc
+    end
+
+    def parse_shortlinks(input)
+      input.gsub(/\[\[([^\]]+)\]\]/) { "[#{$1}](#{$1.to_href})" }
+    end
+
+    def prepend_h1(input)
+      return input if has_h1?(input)
+
+      "# #{title}\n\n#{input}"
+    end
+
+    def has_h1?(input)
+      lines = input.lines(chomp: true).reject(&:empty?)
+      return false if lines.empty?
+
+      lines[0].match(/^# \w+/) || (lines[1] && lines[0].match(/^\w+/) && lines[1].start_with?('='))
+    end
+
+    def redcarpet_options
+      @redcarpet_options ||= {
+        no_intra_emphasis:   true,
+        autolink:            true,
+        tables:              true,
+        fenced_code_blocks:  true,
+        strikethrough:       true,
+        space_after_headers: true,
+        superscript:         true,
+        underline:           true,
+        highlight:           true,
+        quote:               false,
+        footnotes:           true,
+      }
+    end
+
+    def redcarpet_renderer
+      redcarpet_handler.new with_toc_data: true
+    end
+
+    def redcarpet_handler
+      config.highlighter ? HighlightRenderer : Redcarpet::Render::HTML
+    end
+
+    def toc_caption
+      @toc_caption ||= if config.auto_toc.is_a?(String)
+        config.auto_toc
+      else
+        '## Table of Contents'
+      end
+    end
+
+    def toc
+      result = ["#{toc_caption}\n"]
+      markdown.lines(chomp: true).each do |line|
+        next unless line.start_with? '#'
+
+        matches = line.match(/^(?<level>\#{2,3})\s+(?<text>.+)/)
+        next unless matches
+
+        level = matches[:level].size - 1
+        text = matches[:text]
+
+        spacer = '  ' * level
+        result.push "#{spacer}- [#{text}](##{text.to_slug})"
+      end
+
+      result.join "\n"
+    end
+  end
+end

data/lib/madness/settings.rb

@@ -57,8 +57,8 @@ module Madness
         sidebar:           true,
         auto_h1:           true,
         auto_nav:          true,
+        auto_toc:          true,
         highlighter:       true,
-        line_numbers:      true,
         copy_code:         true,
         shortlinks:        false,
         toc:               nil,

data/lib/madness/templates/madness.yml

@@ -20,12 +20,14 @@ auto_h1: true
 # append navigation to directory READMEs
 auto_nav: true
 
+# replace <!-- TOC --> in any file with its internal table of contents
+# set to true to enable it with the default '## Table of Contents' caption,
+# or set to any string that will be inserted before it as a caption.
+auto_toc: true
+
 # enable syntax highlighter for code snippets
 highlighter: true
 
-# enable line numbers for code snippets
-line_numbers: true
-
 # enable the copy to clipboard icon for code snippets
 copy_code: true
 

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = '0.9.9'
+  VERSION = '1.0.0.rc1'
 end