mdless 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc069a55f00ad3b4165a8001caac96382742d1cb653ceb20b45402a76d2ec22
-  data.tar.gz: 1e9749a769176d7c9513c61d5edf51332525282e4067a4b63612028d05f89a3d
+  metadata.gz: 5d7335d03b6ff9a4cd2453de9ecaf5eec3a60fe6dc10d2950cd7b33b298c2852
+  data.tar.gz: b83ff9e51541d1baebb07a747a369e5a90bc073fc590ff5620fa33a320ebb888
 SHA512:
-  metadata.gz: ee64552eeb8c46715bcda2a3ce812affc8988837deacbc70fd856c426fc280108b561f5c2c005c2354cf02e1f09821441df8f0a1331bbf31c5c59e3991f73a70
-  data.tar.gz: 409a8507a1e6419aa2e408872a16a68af8e53e0d5b23594c0cec3175259d35b63474dd39428de78654a7b249cc914f23c03926768210e239de39bf6a8b1a6d06
+  metadata.gz: 20e2aa0e4c82a944fa07cdeed22ea77205387dac18b2393dbd2550620ead1bd1e8b3a9bc2ef130596c273325fa2913f8a0226154988df5cf4452cc004a73b067
+  data.tar.gz: '053559f22fd9d96a802f0a4bb98f40512b37591715e977d1994e00a86698901dc39053f0ffb2ebe0ea455ec930feab1004548f139ed87e0be4511bc64696d5b1'

data/README.md

@@ -16,10 +16,8 @@ I often use iTerm2 in visor mode, so `qlmanage -p` is annoying. I still wanted a
 - Colorize Markdown syntax for most elements
 - Normalize spacing and link formatting
 - Display footnotes after each paragraph
-- Inline image display (local, optionally remote) if using iTerm2 2.9+
+- Inline image display (local, optionally remote) (with compatible tools like imgcat or chafa)
 - Syntax highlighting when [Pygments](http://pygments.org/) is installed
-    - Only fenced code with a language defined (e.g. `python`) will be highlighted
-    - Languages can also be determined by hashbang in the code block
 - List headlines in document
     - Display single section of the document based on headlines
 - Customizable colors
@@ -29,6 +27,8 @@ I often use iTerm2 in visor mode, so `qlmanage -p` is annoying. I still wanted a
 
     gem install mdless
 
+If you run into errors, try `gem install --user-install mdless`, or `sudo gem install mdless` (in that order).
+
 ### Dependencies
 
 Some OSs are missing `tput`, which is necessary for mdless.
@@ -37,16 +37,17 @@ Some OSs are missing `tput`, which is necessary for mdless.
     apt install ruby ncurses-utils
     gem install mdless
 
+To render images, you need `imgcat` or `chafa` installed (`brew install chafa`).
+
+For syntax highlighting, the `pygmentize` command must be available, part of the [Pygments](http://pygments.org/) package (`brew install pygments`).
+
 ## Usage
 
 `mdless [options] path` or `cat [path] | mdless`
 
 The pager used is determined by system configuration in this order of preference:
 
-* `$GIT_PAGER`
 * `$PAGER`
-* `git config --get-all core.pager`
-* `bat`
 * `less`
 * `more`
 * `cat`
@@ -55,18 +56,24 @@ The pager used is determined by system configuration in this order of preference
 ### Options
 
     -c, --[no-]color                 Colorize output (default on)
-    -d, --debug LEVEL                Level of debug messages to output
+    -d, --debug LEVEL                Level of debug messages to output (1-4, 4 to see all messages)
     -h, --help                       Display this screen
-    -i, --images=TYPE                Include [local|remote (both)] images in output (requires imgcat and iTerm2, default NONE)
-    -I, --all-images                 Include local and remote images in output (requires imgcat and iTerm2)
+    -i, --images=TYPE                Include [local|remote (both)] images in output (requires chafa or imgcat, default NONE).
+    -I, --all-images                 Include local and remote images in output (requires imgcat or chafa)
+        --syntax                     Syntax highlight code blocks
         --links=FORMAT               Link style ([inline, reference], default inline) [NOT CURRENTLY IMPLEMENTED]
     -l, --list                       List headers in document and exit
     -p, --[no-]pager                 Formatted output to pager (default on)
     -P                               Disable pager (same as --no-pager)
-    -s, --section=NUMBER             Output only a headline-based section of the input (numeric from --list)
+    -s, --section=NUMBER[,NUMBER]    Output only a headline-based section of the input (numeric from --list)
     -t, --theme=THEME_NAME           Specify an alternate color theme to load
     -v, --version                    Display version number
-    -w, --width=COLUMNS              Column width to format for (default terminal width)
+    -w, --width=COLUMNS              Column width to format for (default: terminal width)
+        --[no-]inline_footnotes      Display footnotes immediately after the paragraph that references them
+
+## Configuration
+
+The first time mdless is run, a config file will be written to `~/.config/mdless/config.yml`, based on the command line options used on the first run. Update that file to make any options permanent (config options will always be overridden by command line flags).
 
 ## Customization
 

data/lib/mdless/console.rb

@@ -8,6 +8,7 @@ module Redcarpet
       @@listitemid = 0
       @@listid = 0
       @@footnotes = []
+      @@headers = []
 
       def xc
         x + color('text')
@@ -491,12 +492,12 @@ module Redcarpet
             indent -= outdent
             "#{' ' * indent}#{l}"
           end.join("\n"), indent)
-        end
+        end + "\n"
       end
 
       def get_headers(input)
-        unless @headers && !@headers.empty?
-          @headers = []
+        unless @@headers && !@@headers.empty?
+          @@headers = []
           headers = input.scan(/^((?!#!)(\#{1,6})\s*([^#]+?)(?: #+)?\s*|(\S.+)\n([=-]+))$/i)
 
           headers.each do |h|
@@ -512,7 +513,7 @@ module Redcarpet
               hlevel = h[1].length
               title = h[2]
             end
-            @headers << [
+            @@headers << [
               '#' * hlevel,
               title,
               h[0]
@@ -520,7 +521,7 @@ module Redcarpet
           end
         end
 
-        @headers
+        @@headers
       end
 
       def preprocess(input)
@@ -545,7 +546,7 @@ module Redcarpet
           end
         end
 
-        if !in_yaml && input.gsub(/\n/, ' ') =~ /(?i-m)^\w.+:\s+\S+/
+        if !in_yaml && input.gsub(/\n/, ' ') =~ /(?i-m)^[\w ]+:\s+\S+/
           @log.info('Found MMD Headers')
           input.sub!(/(?i-m)^([\S ]+:[\s\S]*?)+(?=\n\n)/) do |mmd|
             mmd.split(/\n/).map do |line|
@@ -562,7 +563,7 @@ module Redcarpet
         input.gsub!(/^([^\n]+)\n={3,}\s*$/m, "# \\1\n")
         input.gsub!(/^([^\n]+?)\n-{3,}\s*$/m, "## \\1\n")
 
-        @headers = get_headers(input)
+        @@headers = get_headers(input)
 
         if @options[:section]
           new_content = []
@@ -581,7 +582,7 @@ module Redcarpet
                     in_section = false
                     break
                   end
-                elsif title.downcase == @headers[sect - 1][1].downcase
+                elsif title.downcase == @@headers[sect - 1][1].downcase
                   in_section = true
                   top_level = level + 1
                   new_content.push(graf)

data/lib/mdless/version.rb

@@ -1,3 +1,3 @@
 module CLIMarkdown
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdless
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Brett Terpstra