madness 1.0.0.rc1 → 1.0.0

data/app/styles/_general.scss

@@ -8,10 +8,10 @@ p {
 }
 
 blockquote {
+  color: var(--blockquote-color);
+  border-left: 4px solid var(--blockquote-border-color);
   margin: 0;
   padding: 0 15px;
-  color: #777;
-  border-left: 4px solid #ddd;
 
   &>:first-child {
     margin-top: 0;
@@ -28,9 +28,9 @@ p, blockquote, ul, ol, dl, table, pre {
 }
 
 mark {
-  background-color: palegreen;
+  background-color: var(--highlight-color);
 }
 
 .quiet {
-  color: #777;
+  color: var(--quiet-color);
 }

data/app/styles/_image.scss

@@ -1,7 +1,5 @@
 img {
   border-style: none;
-
   max-width: 100%;
   box-sizing: content-box;
-  background-color: #fff;
 }

data/app/styles/_keyboard.scss

@@ -1,14 +1,15 @@
 kbd {
+  color: var(--kbd-color);
+  background-color: var(--kbd-bg-color);
+  border: solid 1px var(--kbd-border-color);
+  border-bottom-color: var(--kbd-shadow-color);
+  box-shadow: inset 0 -1px 0 var(--kbd-shadow-color);
+
   display: inline-block;
-  padding: 3px 5px;
-  font-size: 11px;
+  padding: 6px 8px;
+  font-size: 85%;
   line-height: 10px;
-  color: #555;
   vertical-align: middle;
-  background-color: #fcfcfc;
-  border: solid 1px #ccc;
-  border-bottom-color: #bbb;
   border-radius: 3px;
-  box-shadow: inset 0 -1px 0 #bbb;
 }
 

data/app/styles/_line.scss

@@ -1,29 +1,4 @@
 hr {
-  box-sizing: content-box;
-  // height: 0;
-  overflow: visible;
-  height: 0;
-  // margin: 15px 0;
-  overflow: hidden;
-  // background: transparent;
   border: 0;
-  border-bottom: 1px solid #ddd;
-
-  height: 4px;
-  padding: 0;
-  margin: 16px 0;
-  background-color: #e7e7e7;
-  // border: 0 none;
-
-  border-bottom-color: #eee;
-
-  &::before {
-    display: table;
-    content: "";
-  }
-  &::after {
-    display: table;
-    clear: both;
-    content: "";
-  }
+  border-top: 2px solid var(--hr-color);
 }

data/app/styles/_manifest.scss

@@ -1,3 +1,5 @@
+@import "variables";
+
 @import "mixins";
 
 @import "anchor";

data/app/styles/_nav.scss

@@ -7,8 +7,8 @@ nav {
     display: none;
   }
 
-  // background: #eee;
-  // border-right: 1px solid #ccc;
+  background: var(--sidebar-bg-color);
+  border-right: 1px solid var(--sidebar-border-right-color);
 
   height: 100vh;
   width: 300px;
@@ -16,11 +16,15 @@ nav {
   position: fixed;
 
   .icon-bar {
-    border-bottom: 1px dotted #ddd;
+    background: var(--sidebar-bg-color);
+    border-bottom: 1px dotted var(--sidebar-border-color);
+    position: sticky;
+    top: 0;
+    z-index: 1;
   }
 
   a.document, span.document, .caption {
-    border-bottom: 1px dotted #ddd;
+    border-bottom: 1px dotted var(--sidebar-border-color);
     // &:hover {
     //   background: #e4e4e4;
     // }

data/app/styles/_scrollbar.scss

@@ -4,6 +4,6 @@
   height: 6px;
 }
 ::-webkit-scrollbar-thumb {
-  background: #ccc;
+  background: var(--scrollbar-color);
   -webkit-border-radius: 3px;
 }

data/app/styles/_search.scss

@@ -22,17 +22,16 @@
 }
 
 .search-field {
+  border: 1px solid var(--search-field-border-color);
+  border-radius: 3px;
+
   outline: none;
   padding: 8px 12px;
   font-size: 1.5em;
-  width: 50%;
-  min-width: 200px;
   width: 100%;
-
-  border: #ccc 1px solid;
-  border-radius: 3px;
+  min-width: 200px;
 
   &:focus {
-    border-color: #4078c0;
+    border-color: var(--search-field-focused-border-color);
   }
 }

data/app/styles/_table.scss

@@ -8,21 +8,26 @@ table {
   word-break: normal;
   word-break: keep-all;
   
+  th, td {
+    padding: 6px 13px;
+    border: 1px solid var(--table-border-color);
+  }
+
+  td {
+    background-color: var(--table-bg-color);
+  }
+
   th {
     font-weight: bold;
+    background-color: var(--table-header-bg-color);
   }
 
-  th, td {
-    padding: 6px 13px;
-    border: 1px solid #ddd;
-  }
 
   tr {
-    background-color: #fff;
-    border-top: 1px solid #ccc;
+    background-color: var(--table-row-bg-color);
   }
 
   tr:nth-child(2n) {
-    background-color: #f8f8f8;
+    background-color: var(--table-alt-row-bg-color);
   }
 }

data/app/styles/_typography.scss

@@ -1,7 +1,7 @@
 body {
   -ms-text-size-adjust: 100%;
   -webkit-text-size-adjust: 100%;
-  color: #333;
+  color: var(--font-color);
   // font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
   font-family: "Segoe UI", "Helvetica Neue", Helvetica,Arial, freesans, sans-serif;
   font-size: 16px;
@@ -21,39 +21,43 @@ h1, h2, h3, h4, h5, h6 {
 }
 
 h1 {
+  color: var(--h1-color);
+  border-bottom: 1px solid var(--h1-border-color);
   margin: 0.67em 0;
   padding-bottom: 0.3em;
   font-size: 2.25em;
   line-height: 1.2;
-  border-bottom: 1px solid #eee;
 }
 
 h2 {
+  color: var(--h2-color);
+  border-bottom: 1px solid var(--h2-border-color);
   padding-bottom: 0.3em;
   font-size: 1.75em;
   line-height: 1.225;
-  border-bottom: 1px solid #eee;
 }
 
 h3 {
+  color: var(--h3-color);
   font-size: 1.5em;
   line-height: 1.43;
 }
 
 h4 {
+  color: var(--h4-color);
   font-size: 1.25em;
 }
 
 h5 {
+  color: var(--h5-color);
   font-size: 1em;
 }
 
 h6 {
+  color: var(--h6-color);
   font-size: 1em;
-  color: #777;
 }
 
 code, pre, kbd {
   font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
-  font-size: 1em;
 }

data/app/styles/_variables.scss

@@ -0,0 +1,40 @@
+:root {
+
+  --background-color: #fff;
+  --blockquote-border-color: #ddd;
+  --blockquote-color: #777;
+  --breadcrumbs-border-color: #ccc;
+  --clipboard-button-bg-color: white;
+  --clipboard-button-border-color: #ccc;
+  --font-color: #333;
+  --footnotes-color: #666;
+  --h1-border-color: #eee;
+  --h1-color: #333;
+  --h2-border-color: #eee;
+  --h2-color: #333;
+  --h3-color: #333;
+  --h4-color: #333;
+  --h5-color: #333;
+  --h6-color: #777;
+  --highlight-color: palegreen;
+  --hr-color: #ddd;
+  --inline-code-bg-color: #eee;
+  --kbd-bg-color: #fcfcfc;
+  --kbd-border-color: #ccc;
+  --kbd-color: #111;
+  --kbd-shadow-color: #bbb;
+  --link-color: #4078c0;
+  --quiet-color: #777;
+  --scrollbar-color: #ccc;
+  --search-field-border-color: #ccc;
+  --search-field-focused-border-color: #4078c0;
+  --sidebar-bg-color: #fff;
+  --sidebar-border-color: #ddd;
+  --sidebar-border-right-color: #ddd;
+  --table-alt-row-bg-color: transparent;
+  --table-bg-color: transparent;
+  --table-border-color: #ddd;
+  --table-header-bg-color: transparent;
+  --table-row-bg-color: transparent;
+
+}

data/app/styles/main.scss

@@ -1,6 +1,7 @@
 @import "manifest";
 
 body {
+  background-color: var(--background-color);
   max-width: 1400px;
   margin: 0 auto;
 }
@@ -29,4 +30,3 @@ body {
     margin: 0 auto;
   }
 }
-

data/app/views/_index_nav.slim

@@ -1,5 +1,6 @@
-ol
-  - nav.links.each do |item|
-    li
-      a href="#{item.href}" class=('strong' if item.type == :dir)
-        = item.label 
+hr
+  ol
+    - nav.links.each do |item|
+      li
+        a href="#{item.href}" class=('strong' if item.type == :dir)
+          = item.label 

data/app/views/document.slim

@@ -6,9 +6,5 @@
   == content
 
   - if type != :file and config.auto_nav
-    - unless type == :empty
-      hr 
-    == slim :_index_nav, locals: { nav: nav }
-
-
-
+    - if nav.links.any?
+      == slim :_index_nav, locals: { nav: nav }

data/app/views/layout.slim

@@ -1,11 +1,16 @@
 doctype html
 
+ruby:
+  custom_css = Dir["css/*.css"].reject { |f| File.basename(f) == 'main.css' }
+
 html
   head
     title = locals[:title]
     meta name="HandheldFriendly" content="true"
     meta name="viewport" content="width=device-width, initial-scale=1"
     link href='/css/main.css' rel='stylesheet' type='text/css'
+    - custom_css.each do |file|
+      link href="/#{file}" rel='stylesheet' type='text/css'
 
     - if config.copy_code
       script src="/js/vendor/jquery.min.js"

data/bin/madness

@@ -1,13 +1,17 @@
 #!/usr/bin/env ruby
-
 require 'madness'
 require 'colsole'
 include Colsole
 
+runner = Madness::CLI.runner
+
 begin
-  Madness::CommandLine.instance.execute ARGV
+  exit runner.run ARGV
+rescue Madness::Interrupt
+  say! "\nGoodbye"
+  exit 1
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+  say! "rib` #{e.class} `\n #{e.message}"
   exit 1
 end

data/lib/madness/cli.rb

@@ -0,0 +1,21 @@
+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
+  class CLI
+    def self.runner
+      runner = MisterBin::Runner.new version: Madness::VERSION,
+        header: 'Markdown Madness - Instant Markdown Server',
+        footer: "Help: m`madness COMMAND --help`\nDocs: bu`https://madness.dannyb.co`"
+
+      # runner.route 'init',      to: Commands::Server
+      runner.route 'server',    to: Commands::Server
+      runner.route 'config',    to: Commands::Config
+      # runner.route 'toc',       to: Commands::TOC
+      runner.route 'theme',     to: Commands::Theme
+
+      runner
+    end
+  end
+end

data/lib/madness/commands/base.rb

@@ -0,0 +1,11 @@
+require 'mister_bin'
+
+module Madness
+  module Commands
+    class Base < MisterBin::Command
+      def config
+        @config ||= Settings.instance
+      end
+    end
+  end
+end

data/lib/madness/commands/config.rb

@@ -0,0 +1,48 @@
+module Madness
+  module Commands
+    class Config < Base
+      summary 'Manage the madness configuration file'
+
+      usage 'bashly config new'
+      usage 'bashly config show'
+      usage 'bashly config (-h|--help)'
+
+      command 'new', 'Create a new .madness.yml configuration file'
+      command 'show', 'Show all configuration options'
+
+      def new_command
+        raise InitError, "Configuration file #{config.filename} already exists" if File.exist? config.filename
+
+        FileUtils.cp File.expand_path('../templates/madness.yml', __dir__), config.filename
+        say "Created g`#{config.filename}` config file"
+      end
+
+      def show_command
+        errors_found = false
+
+        config.data.each do |key, value|
+          value_color = config.defaults[key] == value ? 'n' : 'bb'
+          if config.defaults.has_key?(key)
+            key_color = 'g'
+          else
+            key_color = 'r'
+            value_color = 'r'
+            errors_found = true
+          end
+
+          say "#{key_color}`#{key.to_s.rjust 20}`:  #{value_color}`#{value || '~'}`"
+        end
+
+        say ''
+
+        if config.file_exist?
+          say "Values in bb`blue` loaded from g`#{config.filename}`"
+        end
+
+        return unless errors_found
+
+        say 'Keys in r`red` are not recognized'
+      end
+    end
+  end
+end

data/lib/madness/commands/server.rb

@@ -0,0 +1,75 @@
+module Madness
+  module Commands
+    class Server < Base
+      summary 'Start the server'
+
+      usage 'madness server [PATH] [options]'
+      usage 'madness init (-h|--help)'
+
+      param 'PATH', 'Path to the markdown directory [default: .]'
+
+      option '-p --port NUMBER', 'Set server port number [default: 3000]'
+      option '-b --bind ADDRESS', 'Set server listen address [default: 0.0.0.0]'
+      option '-o --open', 'Open a web browser after launching'
+      option '--auth USER:PASS', 'Enable basic authentication'
+      option '--auth-zone NAME', 'The basic authentication prompt title [default: Restricted Documentation]'
+      option '--theme FOLDER', 'Use a custom theme (either absolute or relative to the main documentation path)'
+
+      example 'madness server'
+      example 'madness server docs'
+      example 'madness server docs -p 4567'
+      example 'madness server docs --open'
+      example 'madness server --auth user:secret --port 4000'
+      example 'madness server --theme _mytheme'
+
+      def run
+        override_config args
+        build_toc if config.toc
+        open_browser if config.open
+        launch_server
+      end
+
+    private
+
+      def launch_server
+        raise ConfigurationError, "Invalid path: #{config.path}" unless File.directory? config.path
+
+        show_status
+        Madness::Server.prepare
+        Madness::Server.run!
+      end
+
+      def build_toc
+        say "g`▌` generating #{config.toc}"
+        Madness::TableOfContents.new.build(config.toc)
+      end
+
+      def open_browser
+        browser = Browser.new config.bind, config.port
+        browser.open do |error|
+          say "r`#{error}`" if error
+        end
+      end
+
+      def override_config(args)
+        config.path       = args['PATH'] if args['PATH']
+        config.port       = args['--port'].to_i if args['--port']
+        config.bind       = args['--bind'] if args['--bind']
+        config.auth       = args['--auth'] if args['--auth']
+        config.auth_zone  = args['--auth-zone'] if args['--auth-zone']
+        config.open       = true if args['--open']
+        config.theme      = File.expand_path(args['--theme'], config.path) if args['--theme']
+      end
+
+      def show_status
+        say 'g`▌` starting server'
+        say "g`▌ env`    : #{Madness::Server.environment}"
+        say "g`▌ listen` : #{config.bind}:#{config.port}"
+        say "g`▌ path`   : #{File.realpath(config.path)}"
+        say "g`▌ config` : #{config.filename}" if config.file_exist?
+        say "g`▌ theme`  : #{config.theme}" if config.theme
+        say ''
+      end
+    end
+  end
+end

data/lib/madness/commands/theme.rb

@@ -0,0 +1,45 @@
+module Madness
+  module Commands
+    class Theme < Base
+      summary 'Create files for theme customization'
+
+      usage 'madness theme full [PATH]'
+      usage 'madness theme css'
+      usage 'madness theme colors'
+      usage 'madness config (-h|--help)'
+
+      command 'full', 'Create a full theme customization directory in PATH [default: _theme]'
+      command 'css', 'Create a folder with the entire CSS file for customization'
+      command 'colors', 'Create a folder with CSS for overriding colors only'
+
+      def full_command
+        raise InitError, "Directory #{theme_path} already exists" if Dir.exist? theme_path
+
+        FileUtils.cp_r File.expand_path('../../../app', __dir__), theme_path
+        say "Created g`#{theme_path}` theme folder"
+      end
+
+      def css_command
+        copy_file 'app/public/css/main.css', 'css/main.css'
+      end
+
+      def colors_command
+        copy_file 'app/styles/_variables.scss', 'css/colors.css'
+      end
+
+    private
+
+      def copy_file(source, target)
+        raise InitError, "File #{target} already exists" if File.exist? target
+
+        FileUtils.mkdir_p File.dirname(target)
+        FileUtils.cp_r File.expand_path("../../../#{source}", __dir__), target
+        say "Created g`#{target}`"
+      end
+
+      def theme_path
+        args['PATH'] || '_theme'
+      end
+    end
+  end
+end

data/lib/madness/exceptions.rb

@@ -0,0 +1,6 @@
+module Madness
+  class Interrupt < Interrupt; end
+  class Error < StandardError; end
+  class InitError < Error; end
+  class ConfigurationError < Error; end
+end

data/lib/madness/refinements/string_refinements.rb

@@ -12,7 +12,7 @@ module Madness
       end
 
       def to_slug
-        downcase.strip.tr(' ', '-').remove(/[^\w-]/)
+        downcase.strip.gsub(/[^\w]/, '-').squeeze('-').remove(/(^-|-$)/)
       end
 
       # This is here so we can have one place that defines how to convert

data/lib/madness/server_base.rb

@@ -36,7 +36,7 @@ module Madness
     end
 
     def self.set_basic_auth
-      use Rack::Auth::Basic, config.auth_realm do |username, password|
+      use Rack::Auth::Basic, config.auth_zone do |username, password|
         config.auth.split(':') == [username, password]
       end
     end

data/lib/madness/settings.rb

@@ -47,7 +47,9 @@ module Madness
       data[:expose_extensions] ? "*.{md,#{data[:expose_extensions].delete(' ')}}" : '*.md'
     end
 
-  private
+    def data
+      @data ||= defaults.merge(file_data)
+    end
 
     def defaults
       {
@@ -65,15 +67,13 @@ module Madness
         theme:             nil,
         open:              false,
         auth:              false,
-        auth_realm:        'Madness',
+        auth_zone:         'Restricted Documentation',
         expose_extensions: nil,
-        exclude:           [/^[a-z_\-0-9]+$/],
+        exclude:           ['^[a-z_\-0-9]+$'],
       }
     end
 
-    def data
-      @data ||= defaults.merge(file_data)
-    end
+  private
 
     def file_data
       result = if file_exist?

data/lib/madness/templates/madness.yml

@@ -50,7 +50,7 @@ open: false
 auth: false
 
 # if auth is enabled, specify auth realm name
-auth_zone: Madness
+auth_zone: Restricted Documentation
 
 # show files with these extensions in the navigation and search, for example:
 # expose_extensions: pdf,docx,xlsx,txt

data/lib/madness/version.rb

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