madness 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17e42d618e170958cf8b556c2271ddb7efeeae6e15144c5e5f4252cdb4708808
-  data.tar.gz: b4fc80231d2cdbc2834dab2a428a501371abbb3b7426984f20833b411314df6e
+  metadata.gz: 7d745803a5a46e353b40e4376b99cc3d1621f04f979c13667d690d786982767a
+  data.tar.gz: 329a470c65598061e69a9dbb0240e2fee6a794a57417d02a51313a3a4f483e24
 SHA512:
-  metadata.gz: 547e6b50b089cac0e4c01bc4938ea14a0cee3985c7dbdcf6bf01a7aa375a4f18f31d720c368918e595c4d03a2ef5f03b6ece929d260c90b523f90d2886b54af5
-  data.tar.gz: 5c72050811de28e4bf8174b1897f847a770f6eeb12844b741c81ca810ba1c345b353e7aac00194f7ca0c01493d5ba664539ae00bdbedb552b81bffec4c07d4f9
+  metadata.gz: bb774064228bb26a7b116571a96bbb556e5c5b8f553e2610dba70b3b3611597b51f323e730b41dbeed471696ebe41102ee805334beca94f35ed3c25ae578fe2f
+  data.tar.gz: 2ab54a17b5e27471662cb415ae4b1ac99beb6f15dfb9e365fa43b0fde33753b9343aec290d5a6d22f55896aaee262fbdc10a71cf0235111743168d3d39f5f917

data/README.md

@@ -1,14 +1,12 @@
-Madness - Instant Markdown Server
-==================================================
+# Madness - Instant Markdown Server
 
 [![Gem Version](https://badge.fury.io/rb/madness.svg)](https://badge.fury.io/rb/madness)
-[![Build Status](https://travis-ci.com/DannyBen/madness.svg?branch=master)](https://travis-ci.com/DannyBen/madness)
+[![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)
 
 ---
 
-Screenshots (click to zoom)
---------------------------------------------------
+## Screenshots (click to zoom)
 
 <table><tr>
   <td><a target='_screenshot' href='assets/screen-main.png'><img src='assets/screen-main.png'/></a></td>
@@ -17,10 +15,7 @@ Screenshots (click to zoom)
   <td><a target='_screenshot' href='assets/screen-search.png'><img src='assets/screen-search.png'/></a></td>
 </tr></table>
 
-
-
-Table of Contents
---------------------------------------------------
+## Table of Contents
 
 * [Install](#install)
 * [Design Intentions](#design-intentions)
@@ -38,25 +33,26 @@ Table of Contents
 * [Forcing HTTPS Connection](#forcing-https-connection)
 * [Docker Image](#docker-image)
 
+## Install
 
+**Using Ruby:**
 
-Install
---------------------------------------------------
-
-    $ gem install madness
+```shell
+$ gem install madness
+```
 
+**Using Docker:**
 
+```shell
+$ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness'
+```
 
-Design Intentions
---------------------------------------------------
+## Design Intentions
 
 Madness was designed in order to provide easy browsing, viewing and 
 searching for local, markdown based documentation directories.
 
-
-
-Feature Highlights
---------------------------------------------------
+## Feature Highlights
 
 - Easy to use.
 - Built-in full text search.
@@ -66,28 +62,23 @@ Feature Highlights
 - Automatic generation of navigation sidebar.
 - Automatic generation of Table of Contents.
 
-
-
-Usage
---------------------------------------------------
+## Usage
 
 Go to any directory that contains markdown files and run:
 
-    $ madness
+```shell
+$ madness
+```
 
 And open <http://localhost:3000> in your browser.
 
 For more options, run:
 
-    $ madness --help
-
-If you do not have Ruby installed, you can also 
-[run madness with docker](#docker-image).
-
-
+```shell
+$ madness --help
+```
 
-Directory Conventions
---------------------------------------------------
+## Directory Conventions
 
 Madness expects to be executed in a documentation directory.
 
@@ -115,10 +106,7 @@ Example structure:
     └── File.md
 ```
 
-
-
-Configuration File
---------------------------------------------------
+## Configuration File
 
 All the command line arguments can also be configured through a 
 configuration file. Create a file named `.madness.yml` in your 
@@ -147,10 +135,7 @@ For convenience, you can get a template config file by running:
 $ madness create config
 ```
 
-
-
-Search
---------------------------------------------------
+## Search
 
 Madness comes with a full text search page. To activate it, you need to
 generate a search index by running `madness --index` or 
@@ -162,10 +147,7 @@ to your documentation server.
 You will need to run this command from time to time, as your 
 documents change or new documents are added.
 
-
-
-Images and Static Files
---------------------------------------------------
+## Images and Static Files
 
 You can put images and other asset files anywhere in your documentation
 folder.
@@ -184,40 +166,28 @@ this markdown:
 If you wish to link to images or pages in a different folder, simply specify
 the path relative to the homepage:
 
-```
+```markdown
 ![alt text](/images/nice-picture.png)
 ```
 
-
-
-Automatic H1
---------------------------------------------------
+## Automatic H1
 
 If your markdown document does not start with a level 1 heading, it
 will be automatically added based on the file name.
 
+## Table of Contents Generation
 
+You can use the `madness --toc FILENAME` command to generate a
+"Table of Contents" markdown file.
 
-Table of Contents Generation
---------------------------------------------------
-
-You can use the `madness --toc` command to generate a "Table of Contents" 
-markdown file.
-
-
-
-Hidden Directories
---------------------------------------------------
+## Hidden Directories
 
 Directories that are made only of lowercase letters, underscoes, dash and/or
 numbers (`/^[a-z_\-0-9]+$/`) will not be displayed in the navigation. In
 other words, directories must have at least one uppercase letter or a space
 to be recognized as a documentation directory.
 
-
-
-Controlling Sort Order
---------------------------------------------------
+## Controlling Sort Order
 
 To control the sort order of the automatically generated navigation elements,
 simply perfix your files and directories with digits followed by a dot and a 
@@ -230,10 +200,7 @@ will be omitted when they are displayed.
 └── 2. Another file or folder
 ```
 
-
-
-Customizing Theme
---------------------------------------------------
+## Customizing Theme
 
 There are two ways to change how Madness looks. 
 
@@ -272,20 +239,16 @@ If you are looking to implement a smaller CSS change, follow these steps:
 Note that this functionality is not guaranteed to stay as is in future 
 versions of madness.
 
-
-
-Forcing HTTPS Connection
---------------------------------------------------
+## Forcing HTTPS Connection
 
 To have Madness redirect HTTP traffic to HTTPS, set this environment 
 variable:
 
-    $ export MADNESS_FORCE_SSL=1
-
-
+```shell
+$ export MADNESS_FORCE_SSL=1
+```
 
-Docker Image
---------------------------------------------------
+## Docker Image
 
 Madness server is also available as a docker image.
 
@@ -296,6 +259,13 @@ directory as the markdown documentation folder
 $ docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
 ```
 
+You may create an alias for convenience:
+
+```shell
+$ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness'
+$ medness --help
+```
+
 For more information about the docker image, see:
 
 - [Madness image on Docker Hub][dockerhub]

data/lib/madness/command_line.rb

@@ -61,10 +61,12 @@ module Madness
     # Get the arguments as provided by docopt, and set them to our own
     # config object.
     def set_config(args)
-      config.path  = args['PATH']   if args['PATH']
-      config.port  = args['--port'].to_i if args['--port']
-      config.bind  = args['--bind'] if args['--bind']
-      config.toc   = args['--toc']  if args['--toc']
+      config.path         = args['PATH']   if args['PATH']
+      config.port         = args['--port'].to_i if args['--port']
+      config.bind         = args['--bind'] if args['--bind']
+      config.toc          = args['--toc']  if args['--toc']
+      config.search_limit = args['--search-limit'].to_i  if args['--search-limit']
+
       config.auto_h1      = false   if args['--no-auto-h1']
       config.auto_nav     = false   if args['--no-auto-nav']
       config.sidebar      = false   if args['--no-sidebar']
@@ -73,6 +75,7 @@ module Madness
       config.copy_code    = false   if args['--no-copy-code']
       config.index        = true    if args['--index']
       config.open         = true    if args['--open']
+      
       config.theme = File.expand_path(args['--theme'], config.path) if args['--theme']
     end
 

data/lib/madness/docopt.txt

@@ -16,16 +16,16 @@ Subcommands:
 
 Parameters:
   PATH:
-    Optional path to the markdown directory.
+    Path to the markdown directory [default: .].
     (Config option: path)
 
 Options:
   -p, --port NUMBER
-    Set server port number.
+    Set server port number [default: 3000].
     (Config option: port)
 
   -b, --bind ADDRESS
-    Set server listen address.
+    Set server listen address [default: 0.0.0.0].
     (Config option: bind)
 
   --no-auto-h1
@@ -68,6 +68,10 @@ Options:
     Generate a table of contents file. 
     (Config option: toc)
 
+  --search-limit LIMIT
+    Maximum number of results to show on the search page [default: 100].
+    (Config option: search_limit)
+
   --open
     Open the browser pointing at the madness webserver.
     (Config option: open)

data/lib/madness/search.rb

@@ -33,7 +33,7 @@ module Madness
       index = Index.new path: index_dir
 
       results = []
-      index.search_each(query, limit: 20) do |doc_id, score| 
+      index.search_each(query, limit: config.search_limit) do |doc_id, score| 
         filename = index[doc_id][:file].sub("#{@path}/", '')[0...-3]
         highlights = index.highlight "content:(#{query.tr(' ',' OR ')}) ", doc_id, field: :content,
           pre_tag: "<strong>", post_tag: "</strong>",
@@ -91,6 +91,10 @@ module Madness
         .join(' / ')
     end
 
+    def config
+      @config ||= Settings.instance
+    end
+
     def file_url(filename)
       filename.remove(/\/(index|README)$/)
     end

data/lib/madness/settings.rb

@@ -49,6 +49,7 @@ module Madness
         auto_h1: true,
         highlighter: true,
         line_numbers: true,
+        search_limit: 100,
         copy_code: true,
         index: false,
         theme: nil,

data/lib/madness/templates/madness.yml

@@ -12,5 +12,6 @@
 # copy_code: true
 # index: false
 # toc: Table of Contents
+# search_limit: 100
 # theme: _theme
 # open: false

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-29 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay