- Add optional 'Page Source' link to all pages

Author: DannyBen

app/views/document.slim

@@ -8,3 +8,9 @@
   - if type != :file and config.auto_nav
     - if nav.links.any?
       == slim :_index_nav, locals: { nav: nav }
+
+  - if %i[file readme].include?(type) && config.source_link
+    - uri = config.source_link % { path: doc.href }
+    hr
+    div
+      a href="#{uri}" = config.source_link_label

lib/madness/document.rb

@@ -18,6 +18,14 @@ def content
       @content ||= %i[empty missing].include?(type) ? "<h1>#{title}</h1>" : markdown.to_html
     end
 
+    def relative_file
+      file[%r{^#{docroot}/(.*)}, 1]
+    end
+
+    def href
+      relative_file.to_href
+    end
+
   private
 
     # Identify file, dir and type.

lib/madness/server.rb

@@ -49,6 +49,7 @@ class Server < ServerBase
       status 404 if doc.type == :missing
 
       slim :document, locals: {
+        doc:         doc,
         content:     content,
         type:        doc.type,
         title:       doc.title,

lib/madness/settings.rb

@@ -64,6 +64,8 @@ def defaults
         highlighter:       true,
         copy_code:         true,
         shortlinks:        false,
+        source_link:       nil,
+        source_link_label: 'Page Source',
         toc:               nil,
         theme:             nil,
         open:              false,

lib/madness/templates/madness.yml

@@ -46,6 +46,16 @@ toc: ~
 # theme: _theme
 theme: ~
 
+# enable a link to the page's source at the bottom of each page by setting
+# a URL pattern here. Use '%{path}' anywhere in the string to get the
+# URI-encoded path of the page.
+# source_link: example.com/%{path}
+source_link: ~
+
+# if source_link is enabled, you can change the default link label
+# source_link_label: Edit Page
+source_link_label: Page Source
+
 # open the server URL in the browser
 open: false
 

spec/approvals/cli/config/show

@@ -9,6 +9,8 @@
          highlighter:  true
            copy_code:  true
           shortlinks:  ~
+         source_link:  ~
+   source_link_label:  Page Source
                  toc:  ~
                theme:  ~
                 open:  ~

spec/approvals/cli/config/show-non-default

@@ -9,6 +9,8 @@
          highlighter:  true
            copy_code:  true
           shortlinks:  ~
+         source_link:  ~
+   source_link_label:  Page Source
                  toc:  Table of Contents
                theme:  my_theme
                 open:  ~

spec/fixtures/docroot-with-edit/.madness.yml

@@ -0,0 +1,2 @@
+source_link: example.com/%{path}
+source_link_label: Edit Page

spec/fixtures/docroot-with-edit/Empty Folder/.keep

@@ -0,0 +1 @@
+me

spec/fixtures/docroot-with-edit/Folder with Index/index.md

@@ -0,0 +1 @@
+# This is a docroot index fixture