madness 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89018d212a6eb10fa20bcbf6874d00201639f636b3f015d1d091cef82fb0cc84
-  data.tar.gz: 2b0e17b9b9802d0ad2d0dd92dd3e35ddd28bfbf9b4a79f9347b733d7d8feb520
+  metadata.gz: 4548ff821bb0396f536bc5d7228a03bc44307c9eb60b1282c74aee8519f1dd86
+  data.tar.gz: d438320e3e8a819aa6e90dac8d9a77140444270fceccedf6f5a199c53d685d45
 SHA512:
-  metadata.gz: f6d63da556f0a76366ca5dbbff71c2e488d04bfec985a3d4c388ea51b7dbb51ddf3f643701d96e4cfbdea1965e2bb71681e3cec84b6b2644ed73262f1bc72669
-  data.tar.gz: 050aa5976b73a39cffcf0d1ef4d56887952253641853c5b1ec2d6960aad7cc5276939692a1f5adce042b42519a0a57c9b33390c8ea3dcefea69ef46af249ef4a
+  metadata.gz: 05caa89aa6745f72cc6552ae8b4376db76bace2561196c220fa94958c327a1b9ade31686f0ad38a8c847a13a80a08ab173de2edfddbd689db4848e49060578f5
+  data.tar.gz: 4f8937f11e93d872d1d1a3c1cc5015e5bb326a84d6a34a086fa9fe077db7aa09dbfdba170dcac1f6e0120aef26acbaf71230e32199d05d074ceaa8d4e1db9990

data/README.md

@@ -36,7 +36,7 @@ Feature Highlights
 
 - Easy to use
 - Built in full text search
-- Built in GraphViz diagram generator
+- Compatible with how markdown files are displayed on GitHub andGitHub pages.
 - Configure with a configuration file or command arguments
 
 
@@ -129,10 +129,7 @@ You can put images and any other asset file anywhere in your documentation
 folder.
 
 When linking to other pages or images in your documentation folder, simply
-use the URL relative to the markdown file. Madness will convert these to be
-relative to the docroot of the generated site.
-
-This behavior mimics how GitHub is rendering markdown files.
+use the URL relative to the markdown file. 
 
 For example, if you have a folder named `subfolder` that contains a 
 `README.md` and a `nice-picture.png`, showing it in your `README` is done by
@@ -158,18 +155,37 @@ If your markdown document does not start with a level 1 heading, it
 will be automatically added based on the file name.
 
 
+
 Hidden Directories
 --------------------------------------------------
 
-Directories that begin with an underscore will not be displayed in the
-navigation.
+These directories will not be displayed in the navigation:
+
+- Directories that begin with an underscore.
+- Directories that are made only of lowercase letters, underscoew, dash and/or 
+  numbers (`/^[a-z_\-0-9]+$/`).
+
+
+
+Changing Theme
+--------------------------------------------------
+
+To change the CSS of your documentation server:
+
+- Create a directory named `css` in your root documentation directory.
+- Copy the [main.css][css] file to it.
+- Update it as you see fit.
+
+Note that this functionality is not guaranteed to stay as is in future 
+versions of madness, since support for themes is still not yet fully 
+implemented.
 
 
 
 Docker Image
 --------------------------------------------------
 
-This gem is also available as a docker image.
+Madness server is also available as a docker image.
 
 This command will start the server on localhost:3000, with the current 
 directory as the markdown documentation folder
@@ -190,5 +206,5 @@ For more information see:
 [screenshot]: https://raw.githubusercontent.com/DannyBen/madness/master/screenshot.png
 [dockerhub]: https://hub.docker.com/r/dannyben/madness/
 [dockerfile]: https://github.com/DannyBen/docker-madness
-
+[css]: app/public/css/main.css
 

data/lib/madness/document.rb

@@ -15,6 +15,7 @@ module Madness
       @path = path
 
       base = path.empty? ? docroot : "#{docroot}/#{path}"
+      base.chomp! '/'
 
       if File.directory? base
         @file = "#{base}/README.md"
@@ -48,7 +49,7 @@ module Madness
 
     # Return a reasonable HTML title for the file or directory
     def title
-      if file =~ /README.md/
+      if type == :readme
         result = File.basename File.dirname(file)
       else
         result = File.basename(file,'.md')
@@ -56,10 +57,6 @@ module Madness
       result.tr '-', ' '
     end
 
-    def relative_dir
-      @relative_dir ||= dir[/#{docroot}\/(.*)/,1]
-    end
-
     private
 
     # Convert markdown to HTML, wit hsome additional processing:
@@ -67,7 +64,6 @@ module Madness
     # 2. Prepend H1 if needed
     def markdown_to_html
       doc = CommonMarker.render_doc(File.read file)
-      fix_relative_links doc if relative_dir
       html = doc.to_html
       html = syntax_highlight(html) if config.highlighter
       html = prepend_h1(html) if config.autoh1
@@ -99,18 +95,6 @@ module Madness
         CodeRay.scan(code, lang).html opts
       end
     end
-
-    def fix_relative_links(doc)
-      doc.walk do |node|
-        if [:link, :image].include? node.type
-          node.url = "/#{relative_dir}/#{node.url}" if relative? node.url
-        end
-      end
-    end
-
-    def relative?(link)
-      !(link.include? ':' or link[0] == '/')
-    end
   end
 end
 

data/lib/madness/navigation.rb

@@ -45,7 +45,7 @@ module Madness
       dirs  = Dir["#{dir}/*"].select { |f| File.directory? f }
       dirs.reject! do |f| 
         basename = File.basename(f)
-        basename[0] == '_'
+        basename[0] == '_' or basename =~ /^[a-z_\-0-9]+$/
       end
       dirs
     end

data/lib/madness/server.rb

@@ -17,10 +17,14 @@ module Madness
     get '/*' do
       path = params[:splat].first
 
-      doc = Document.new path
+      doc     = Document.new path
       dir     = doc.dir
       content = doc.content
 
+      if doc.type == :readme and !path.empty? and path[-1] != '/'
+        redirect "#{path}/"
+      end
+
       nav = Navigation.new(dir)
       breadcrumbs = Breadcrumbs.new(path).links
 

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass