- Add support for [[Short Links]]

Author: DannyBen

README.md

@@ -4,13 +4,6 @@
 [![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)
 
---- 
-## Differences from [original](https://github.com/DannyBen/madness)
-
-### support for link format used by smart-notes apps like Obsidian. 
-
-Markdown based smart-notes apps frequently use a non-standard link format in the form of `[[Link]]` where Link is equally the link text and the name of the local markdown file to link to. `[[Link]]` would therefore translate to `[Link](./Link.md)`
-
 ---
 
 ## Screenshots (click to zoom)
@@ -33,6 +26,7 @@ Markdown based smart-notes apps frequently use a non-standard link format in the
 * [Search](#search)
 * [Images and Static Files](#images-and-static-files)
 * [Automatic H1](#automatic-h1)
+* [Shortlinks](#shortlinks)
 * [Table of Contents Generation](#table-of-contents-generation)
 * [Hidden Directories](#hidden-directories)
 * [Controlling Sort Order](#controlling-sort-order)
@@ -77,6 +71,7 @@ searching for local, markdown based documentation directories.
 - Automatic generation of navigation sidebar.
 - Automatic generation of Table of Contents (site-wide and inline).
 - Can optionally show additional file types in the navigation menu (e.g. PDF files).
+- Optional support for `[[Short Link]]` syntax.
 
 ## Usage
 
@@ -158,6 +153,9 @@ line_numbers: true
 # enable the copy to clipboard icon for code snippets
 copy_code: true
 
+# convert [[Links]] to [Links](Links)
+shortlinks: false
+
 # generate a table of contents file with this name, for example:
 # toc: Table of Contents
 toc: ~
@@ -183,9 +181,6 @@ expose_extensions: ~
 # exclude directories that match these regular expressions
 # note that this is an array
 exclude: ['^[a-z_\-0-9]+$']
-
-# support for internal links in the form [[Link Title and Filename]]
-shortlinks: true
 ```
 
 For convenience, you can generate a template config file by running:
@@ -226,6 +221,13 @@ the path relative to the homepage:
 If your markdown document does not start with a level 1 heading, it
 will be automatically added based on the file name.
 
+## Shortlinks
+
+When the `shortlinks` option is enabled, you may use a shorthand syntax for 
+specifying internal links, where `[[Anything]]` will be converted to
+`[Anything](Anything)`, which will then be rendered as an internal link to a
+file or a directory in the same directory as the file itself.
+
 ## Table of Contents Generation
 
 ### Site-wide

lib/madness/command_line.rb

@@ -74,14 +74,15 @@ def set_config(args)
       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']
     end
 
     # Generate index and toc, if requested by the user.
     def generate_stuff
-      build_toc   if config.toc
+      build_toc if config.toc
     end
 
     # Create config

lib/madness/docopt.txt

@@ -55,6 +55,10 @@ Options:
     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.

lib/madness/document.rb

@@ -66,13 +66,13 @@ def set_base_attributes_for_directory
     end
 
     def markdown
-      @markdown ||= File.read file
-      @markdown = shortlinks(@markdown) if config.shortlinks
-      @markdown
+      @markdown ||= pre_process_markdown
     end
 
-    def shortlinks(raw)
-      raw.gsub(/\[\[([^\]]+)\]\]/) { "[#{Regexp.last_match(1)}](./#{Regexp.last_match(1).to_href}.md)" }
+    def pre_process_markdown
+      result = File.read file
+      result = evaluate_shortlinks result if config.shortlinks
+      result
     end
 
     def doc
@@ -119,6 +119,11 @@ def replace_toc_marker
       toc_marker.insert_after CommonMarker.render_doc("## Table of Contents").first_child
     end
 
+    # Replace [[link]] with [link](link)
+    def evaluate_shortlinks(raw)
+      raw.gsub(/\[\[([^\]]+)\]\]/) { |match| "[#{$1}](#{$1.to_href})" }
+    end
+
     # Returns a UL object containing the document table of contents
     def document_toc
       toc = []

lib/madness/templates/madness.yml

@@ -29,6 +29,9 @@ line_numbers: true
 # enable the copy to clipboard icon for code snippets
 copy_code: true
 
+# convert [[Links]] to [Links](Links)
+shortlinks: false
+
 # generate a table of contents file with this name, for example:
 # toc: Table of Contents
 toc: ~

spec/fixtures/cli/help

@@ -55,6 +55,10 @@ Options:
     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.

spec/fixtures/docroot/File with Shortlink.md

@@ -0,0 +1,2 @@
+This file contains a [[Shortlink]] to an internal file.
+

spec/fixtures/toc

@@ -27,6 +27,7 @@
 1. [Double Escape](/Double%20Escape)
 1. [File](/File)
 1. [File-with-Dashes](/File-with-Dashes)
+1. [File with Shortlink](/File%20with%20Shortlink)
 1. [File with Spaces](/File%20with%20Spaces)
 1. [File with TOC](/File%20with%20TOC)
 1. [File without H1](/File%20without%20H1)

spec/madness/document_spec.rb

@@ -276,5 +276,13 @@
         expect(doc.content).not_to have_tag :h1
       end
     end
+
+    context "with shortlinks enabled" do
+      it "evaluates shortlinks" do
+        config.shortlinks = true
+        doc = described_class.new "File with Shortlink"
+        expect(doc.content).to have_tag(:a, with: { href: "Shortlink" }, text: "Shortlink")
+      end
+    end
   end
 end