mdless 2.0.23 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eaea78c835d8fcd10e100f47897d6a35201abaaa553c01812ab392100175edb
-  data.tar.gz: 82b99dfb00e22ff425dac9225b09ca6a373e92f6e328c849db5719c180002ee1
+  metadata.gz: cd020f19c756d65ae77a7776165c1aeadd0b2339a9dcabf82018f7e7a10105fc
+  data.tar.gz: 650881325a80cd06c61656f339a30d8e45f74b667842691c82e9a2b6b0ab3184
 SHA512:
-  metadata.gz: 6f7848e8660d9b8c3383b17885a85be12b52cc42212444b316087b6d081666a883dfdf40bea21e4858c71cc7ef4ba51f5e9fecb63f52d853e740951cfaaf86bd
-  data.tar.gz: 1622b095f616a0b36525712ffe2a44db665772fc2b5b1b3dced4eb3a53d689e335a5fd7008361b295b8a2183e7fc3dd6d8dc4aa468f7c3ea17e9550ed3d68209
+  metadata.gz: f41c118304004d8eb6f332b1edc66a51d6a4f346140acceb93db291bcade96635172f9e0c412119e60aad889ba6e4354e1491bf6ebf8d59b86770e408ff930fe
+  data.tar.gz: 5a9bdc6051825f50720a20a7767dbe759982a6b368f08b20905b703ffe7882d654aed737c919e445231bffefbb67328774856518546ba15e86667adf23c7b9c3

data/README.md

@@ -62,11 +62,13 @@ The pager used is determined by system configuration in this order of preference
     -@, --at_tags                    Highlight @tags and values in the document
     -v, --version                    Display version number
     -w, --width=COLUMNS              Column width to format for (default: terminal width)
+        --[no-]autolink              Convert bare URLs and emails to <links>
         --[no-]inline_footnotes      Display footnotes immediately after the paragraph that references them
         --[no-]intra-emphasis        Parse emphasis inside of words (e.g. Mark_down_)
         --[no-]lax-spacing           Allow lax spacing
         --links=FORMAT               Link style ([inline, reference, paragraph], default inline,
                 "paragraph" will position reference links after each paragraph)
+        --[no-]linebreaks            Preserve line breaks
         --[no-]syntax                Syntax highlight code blocks
         --taskpaper=OPTION           Highlight TaskPaper format (true|false|auto)
         --update_config              Update the configuration file with new keys and current command line options
@@ -76,6 +78,43 @@ The pager used is determined by system configuration in this order of preference
 
 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).
 
+```
+---
+:at_tags: true
+:autolink: true
+:color: true
+:inline_footnotes: true
+:intra_emphasis: false
+:lax_spacing: true
+:links: :paragraph
+:local_images: true
+:pager: true
+:preserve_linebreaks: false
+:remote_images: false
+:syntax_higlight: true
+:taskpaper: :auto
+:theme: default
+:width: 120
+:wiki_links: true
+```
+
+- The `:at_tags` setting determines whether @tags will be highlighted. If this is enabled, colors will be pulled from the `at_tags` settings in the theme.
+- `:autolink` will determine whether bare urls are turned into `<self-linking>` urls.
+- `:color` will enable or disable all coloring.
+- `:inline_footnotes` will determine the placement of footnotes. If true, footnotes will be added directly after the element that refers to them.
+- `:intra_emphasis` will determine whether words containing underscores are rendered as italics or not.
+- `:lax_spacing` determines whether a blank line is required around HTML elements.
+- `:links` can be `inline`, `reference`, or `paragraph`. Paragraph puts reference links directly after the graf that refers to them.
+- `:local_images` determines whether local images are processed using `chafa` or `imgcat` (whichever is available). `:remote_images` does the same for images referenced with web urls. If `:remote_images` is true, then `:local_images` is automatically enabled.
+- `:pager` turns on or off pagination using `less` or closest available substitute.
+- `:preserve_linebreaks` determines whether hard breaks within paragraphs are preserved. When converting to HTML, most Markdown processors will cause consecutive lines to be merged together, which is the default behavior for `mdless`. Turning this option on will cause lines to remain hard wrapped.
+- `:syntax_highlight` will turn on/off syntax highlighting of code blocks (requires Pygments)
+- `:taskpaper` determines whether a file is rendered as a TaskPaper document. This can be set to `:auto` to have TaskPaper detected from extension or content.
+- `:theme` allows you to specify an alternate theme. See Customization below.
+- `:width` allows you to permanantly set a width for wrapping of lines. If the width specified is greater than the available columns of the display, the display columns will be used instead.
+- `:wiki_links` determines whether `[[wiki links]]` will be highlighted. If highlighted, colors are pulled from the `link` section of the theme.
+
+
 ## Customization
 
 On first run a default theme file will be placed in `~/.config/mdless/mdless.theme`. You can edit this file to modify the colors mdless uses when highlighting your files. You can copy this file and create multiple theme options which can be specified with the `-t NAME` option. For example, create `~/.config/mdless/brett.theme` and then call `mdless -t brett filename.md`.
@@ -139,4 +178,75 @@ To set a background color, use `on_[color]` with one of the 8 colors. This can b
 
 Use 'd' (dark) to indicate the darker version of a foreground color. On macOS (and possibly other systems) you can use the brighter version of a color by prefixing with "intense", e.g. `intense_red` or `on_intense_black`.
 
+## Integrations
+
+### Ranger
+
+[Ranger](https://ranger.github.io) is a file manager that allows for quick navigation in the file hierarchy. A preview can be displayed for various file types. See docs at <https://github.com/ranger/ranger/wiki>.
+
+mdless can be used in Ranger to preview Markdown and Taskpaper.
+
+Ranger is installed with `brew install ranger`.
+
+With `ranger --copy-config=scope` the configuration file for previews `scope.sh` is created in the directory `~/.config/ranger`.
+
+The configuration file is already preconfigured. The following can be inserted above html to use mdless.
+
+```
+## Markdown
+md|taskpaper)
+mdless --taskpaper=auto -@ "${FILE_PATH}" && exit 5
+;;
+```
+
+### Gather
+
+[Gather](https://brettterpstra.com/projects/gather-cli/) is a tool for converting web pages to Markdown. You can use it with mdless to create a Lynx-style web browser:
+
+```bash
+$ gather https://brettterpstra.com/projects/gather-cli/ | mdless
+```
+
+### fzf
+
+[fzf](https://github.com/junegunn/fzf) is a tool for selecting files and other menu options with typeahead fuzzy matching. You can set up `mdless` as a previewer when selecting Markdown or TaskPaper files.
+
+```
+$ ls *.md | fzf --preview 'mdless --taskpaper auto --linebreaks {}'
+```
+
+### Fish
+
+You can replace the cat command in Fish by creating the following functions in `~/.config/fish/functions`
+
+`get_ext.fish`
+
+```fish
+function get_ext -d 'Get the file extension from the argument'
+    set -l splits (string split "." $argv)
+    echo $splits[-1]
+end
+```
+
+`cat.fish`
+
+```fish
+function cat -d "Use bat instead of cat unless it's a Markdown file, then use mdless"
+    set -l exts md markdown txt taskpaper
+
+    if not test -f $argv[-1]
+        echo "File not found: $argv"
+        return 0
+    end
+
+    if contains (get_ext $argv) $exts
+        mdless $argv
+    else
+        command bat --style plain --theme OneHalfDark $argv
+    end
+end
+```
+
+Note that if you do this, and you need uncolored output to pipe somewhere, you'll need to use `command cat FILE` to revert to the built-in `cat`. Otherwise your text will be full of the escape codes that `mdless` uses to colorize the output.
+
 <!--END README-->

data/lib/mdless/console.rb

@@ -232,7 +232,7 @@ module Redcarpet
         if MDLess.options[:preserve_linebreaks]
           "#{xc}#{text.gsub(/ +/, ' ').strip}#{xc}#{x}\n\n"
         else
-          "#{xc}#{text.gsub(/ +/, ' ').gsub(/\n+/, ' ').strip}#{xc}#{x}\n\n"
+          "#{xc}#{text.gsub(/ +/, ' ').gsub(/\n+(?![:-])/, ' ').strip}#{xc}#{x}\n\n"
         end
       end
 
@@ -709,11 +709,12 @@ module Redcarpet
       def preprocess(input)
         input = color_meta(input)
 
+        replaced_input = input.clone
         ## Replace setex headers with ATX
-        input.gsub!(/^([^\n]+)\n={2,}\s*$/m, "# \\1\n")
-        input.gsub!(/^([^\n]+?)\n-{2,}\s*$/m, "## \\1\n")
+        replaced_input.gsub!(/^([^\n]+)\n={2,}\s*$/m, "# \\1\n")
+        replaced_input.gsub!(/^([^\n]+?)\n-{2,}\s*$/m, "## \\1\n")
 
-        @headers = get_headers(input)
+        @headers = get_headers(replaced_input)
 
         if MDLess.options[:section]
           new_content = []

data/lib/mdless/converter.rb

@@ -88,7 +88,7 @@ module CLIMarkdown
 
         default(:section, nil)
         opts.on('-s', '--section=NUMBER[,NUMBER]',
-                'Output only a headline-based section of the input (numeric from --list)') do |section|
+                'Output only a headline-based section of the input (numeric from --list or text match)') do |section|
           sections = section.split(/ *, */).map(&:strip)
           MDLess.options[:section] = sections.map do |sect|
             if sect =~ /^\d+$/
@@ -126,6 +126,28 @@ module CLIMarkdown
           MDLess.options[:autolink] = p
         end
 
+        opts.on('--config', "Open the config file in #{ENV['EDITOR'] || 'default editor'}") do
+          raise 'No $EDITOR defined' unless ENV['EDITOR']
+
+          `#{ENV['EDITOR']} '#{File.expand_path('~/.config/mdless/config.yml')}'`
+        end
+
+        opts.on('--changes', 'Open the changelog to see recent updates') do
+          changelog = File.join(File.dirname(__FILE__), '..', '..', 'CHANGELOG.md')
+          system "mdless --linebreaks '#{changelog}'"
+          Process.exit 0
+        end
+
+        opts.on('--edit-theme', ["Open the default or specified theme file in #{ENV['EDITOR'] || 'default editor'}. ",
+                                 "If theme doesn't exist, a new theme file will be populated and opened."].join) do
+          raise 'No $EDITOR defined' unless ENV['EDITOR']
+
+          theme = MDLess.options[:theme] =~ /default/ ? 'mdless' : MDLess.options[:theme]
+          theme = File.expand_path("~/.config/mdless/#{theme}.theme")
+          File.open(theme, 'w') { |f| f.puts(YAML.dump(MDLess.theme)) } unless File.exist?(theme)
+          `#{ENV['EDITOR']} '#{theme}'`
+        end
+
         default(:inline_footnotes, false)
         opts.on('--[no-]inline_footnotes',
                 'Display footnotes immediately after the paragraph that references them') do |p|
@@ -156,7 +178,7 @@ module CLIMarkdown
                              end
         end
 
-        default(:preserve_linebreaks, false)
+        default(:preserve_linebreaks, true)
         opts.on('--[no-]linebreaks', 'Preserve line breaks') do |opt|
           MDLess.options[:preserve_linebreaks] = opt
         end

data/lib/mdless/string.rb

@@ -107,7 +107,7 @@ class ::String
     log = MDLess.log
     tag_color = color('at_tags tag')
     value_color = color('at_tags value')
-    gsub(/(?<pre>\s|m)(?<tag>@[^ \].?!,("']+)(?:(?<lparen>\()(?<value>.*?)(?<rparen>\)))?/) do
+    gsub(/(?<pre>\s|m)(?<tag>@[^ \].?!,("'\n]+)(?:(?<lparen>\()(?<value>.*?)(?<rparen>\)))?/) do
       m = Regexp.last_match
       last_color = m.pre_match.last_color_code
       [

data/lib/mdless/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CLIMarkdown
-  VERSION = '2.0.23'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdless
 version: !ruby/object:Gem::Version
-  version: 2.0.23
+  version: 2.1.1
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet