madness 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e6d1a2a1af740dbcace6dcf480bdb39bd070f1a2950d0bfdc75728ee99104cf
-  data.tar.gz: 4342dcc15681c42998f97736dda3d118c5062e295beae85e482ebf850e920977
+  metadata.gz: 4d1899b2ed090d1ff053077a195f6e5a8c80a24ba66ebbe6e9ed1f50ad167a5c
+  data.tar.gz: d13d70143ba4f3ac510e83d738df2d5a1cb15f03db33f2ac2e9c255fabb8ff19
 SHA512:
-  metadata.gz: 0d8c1f9366a41f91332e775c8c26d3a1994f4b13694a342a55c18a8cf99124f59257b3ce7f7ce1634c5759003dcfeb3a63f74f75ee1abaf835a30c9e83d68f9d
-  data.tar.gz: 7ed9cafc3418cdd966a55c2d0ba2fddee9e5e3bdae5c159e6caea8108d845d32a78ccdd77464469f8ff3cbdd70e70dac79e652e6001e980ea8662a3a0530ddee
+  metadata.gz: 61e495e8e475069111ba693451bbde77876e5ddf784a035250aaca3321defe30409a011bcb3264519812d992b7bd050625cf3d719eb286b90eecc73e6a40050a
+  data.tar.gz: 796aa6f34076dffdb370233f21f7df5973142839f8fc4cdfbc1666c426d518498a83daf604e999c61fcd72045876dd966f5c50cca4249b4a3b06153bc4b679da

data/README.md

@@ -29,6 +29,7 @@
 * [Table of Contents Generation](#table-of-contents-generation)
 * [Hidden Directories](#hidden-directories)
 * [Controlling Sort Order](#controlling-sort-order)
+* [Displaying Additional File Types](#displaying-additional-file-types)
 * [Basic Authntication](#basic-authentication)
 * [Customizing Theme](#customizing-theme)
 * [Forcing HTTPS Connection](#forcing-https-connection)
@@ -62,6 +63,7 @@ searching for local, markdown based documentation directories.
 - Fully customizable theme.
 - 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).
 
 ## Usage
 
@@ -124,9 +126,10 @@ auto_nav: true
 highlighter: true
 line_numbers: true
 copy_code: true
-dtoc: Table of Contents
+toc: Table of Contents
 theme: _theme
 open: false
+expose_extensions: ~
 ```
 
 For convenience, you can get a template config file by running:
@@ -201,6 +204,19 @@ will be omitted when they are displayed.
 └── 2. Another file or folder
 ```
 
+## Displaying Additional File Types
+
+If you wish the navigation and search features to also show other documents
+and files (for example, PDF files), you may configure the `expose_extensions`
+option in the configuration file to contain a comma delimited list of
+extensions:
+
+```yaml
+expose_extensions: pdf,docx,xlsx,txt
+```
+
+The default value of this option is `null` (or `~`, which is `null` in YAML).
+
 ## Basic Authentication
 
 To add basic authentication, use the `--auth user:password` command line argument or the equivalent `auth` configuration option.

data/lib/madness/directory.rb

@@ -17,7 +17,7 @@ module Madness
   private
 
     def files
-      result = Dir["#{dir}/*.md"]
+      result = Dir["#{dir}/#{config.dir_glob}"]
       result.reject! do |f| 
         basename = File.basename(f)
         basename == 'README.md' or basename == 'index.md'
@@ -33,5 +33,10 @@ module Madness
       end
       result.nat_sort.map { |path| Item.new path, :dir }
     end
+
+    def config
+      @config ||= Settings.instance
+    end
+
   end
 end

data/lib/madness/search.rb

@@ -21,7 +21,7 @@ module Madness
       return result if words.empty?
 
       index.each do |file, content|
-        file = file.remove("#{@path}/")[0...-3]
+        file = file.remove("#{@path}/").sub(/.md$/, '')
         url = file_url file
         label = file_label file
         found = 0
@@ -37,10 +37,12 @@ module Madness
 
     def index!
       results = {}
-      Dir["#{@path}/**/*.md"].sort.each do |file|
+
+      Dir["#{@path}/**/#{config.dir_glob}"].sort.each do |file|
         next if skip_index? file
-        filename = file_url(file.sub("#{@path}/", '')[0...-3]).downcase
-        content = File.read(file).downcase
+        filename = file_url(file.sub("#{@path}/", '')).downcase
+        index_content = File.extname(file) == '.md'
+        content = index_content ? File.read(file).downcase : ''
         results[file] = "#{filename} #{content}"
       end
       results

data/lib/madness/settings.rb

@@ -40,6 +40,10 @@ module Madness
       '.madness.yml'
     end
 
+    def dir_glob
+      data[:expose_extensions] ? "*.{md,#{data[:expose_extensions].delete(' ')}}" : "*.md"
+    end
+
   private
 
     def defaults
@@ -56,7 +60,8 @@ module Madness
         auto_nav: true,
         sidebar: true,
         auth: false,
-        auth_realm: 'Madness'
+        auth_realm: 'Madness',
+        expose_extensions: nil
       }
     end
 

data/lib/madness/templates/madness.yml

@@ -15,3 +15,4 @@
 # open: false
 # auth: false
 # auth_zone: 'Madness'
+# expose_extensions: ~

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay