madness 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 522b6812a30a5263c3860e0dd78d9d516d75142e
-  data.tar.gz: dec8f6ee48993a3f02318bd43f3469897544c72a
+  metadata.gz: 6a993c5b2a6cb0783cb9ad3dde72db4c5142e56a
+  data.tar.gz: 80907e9259ada12a01a70b2a14894a9954e7a8c7
 SHA512:
-  metadata.gz: c23ac24a8659d80b208020c332c32166d1066874392dd1a1ecf5ff8619a1610caf3832f122b5d40c1c7cd9a58db195529e3585ae16b6b9fd2a30126882720685
-  data.tar.gz: e757685713c3379b1cf91f2cb55721b536fb2bb76434a451cf8be4fd3659674cf4066b15173e5cf25562849c40511db0110f111d18f6080294625776185686ce
+  metadata.gz: 3be0f236806182e99ffb625aa454903222a0b5a67ebf84dbd9f47c2b361ac7df0cb0baf3915f076a1c352c0687872098470b9837132f3bad9ef5cc5c058ceae1
+  data.tar.gz: d12e02d9035f96fdf0b2f98157d7269061a4bb252db4475aef2574360313dc6a8e498ccbdce7ef9ef99274353adc1dfc3ba096b995a8da37e56b9a9f0b4df335

data/README.md

@@ -20,6 +20,13 @@ Install
     $ bundle install madness
 
 
+Design Intentions
+--------------------------------------------------
+
+Madness was designed in order to provide easy browsing, viewing and 
+searching for local, markdown based documentation directories.
+
+
 Usage
 --------------------------------------------------
 
@@ -38,7 +45,7 @@ Directory Conventions
 Madness expects to be executed in a documentation directory.
 
 A documentation directory contains only markdown files (`*.md`) and 
-subfolders that contain more markdown files.
+sub directories that contain more markdown files.
 
 The server will consider the file `README.md` in any directory as the 
 main file describing this directory.
@@ -82,6 +89,20 @@ line_numbers: true
 ```
 
 
+Search
+--------------------------------------------------
+
+Madness comes with a full text search page. To activate it, you need to
+generate a search index by running `madness --index` or 
+`madness path/to/docs --index`.
+
+This will create an `_index` sub folder, and will add a new search page
+to your documentation server.
+
+You will need to run this command from time to time, as your 
+documents change or new documents are added.
+
+
 Tips
 --------------------------------------------------
 

data/app/public/css/main.css

@@ -197,6 +197,20 @@ kbd {
   border-radius: 3px;
   box-shadow: inset 0 -1px 0 #bbb; }
 
+.search-form {
+  margin-bottom: 20px; }
+
+.search-field {
+  outline: none;
+  padding: 8px 12px;
+  font-size: 1.5em;
+  width: 50%;
+  min-width: 200px;
+  border: #ccc 1px solid;
+  border-radius: 3px; }
+  .search-field:focus {
+    border-color: #4078c0; }
+
 * {
   box-sizing: border-box; }
 

data/app/public/css/main.css.map

@@ -1,7 +1,7 @@
 {
 "version": 3,
-"mappings": "AAAA,IAAK;EACH,oBAAoB,EAAE,IAAI;EAC1B,wBAAwB,EAAE,IAAI;EAC9B,KAAK,EAAE,IAAI;EACX,WAAW,EAAE,8HAA8H;EAC3I,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,UAAU;;AAGvB,eAAgB;EACd,WAAW,EAAE,MAAM;;AAGrB,sBAAuB;EACrB,UAAU,EAAE,GAAG;EACf,aAAa,EAAE,IAAI;EACnB,WAAW,EAAE,IAAI;EACjB,WAAW,EAAE,GAAG;;AAGlB,EAAG;EACD,MAAM,EAAE,QAAQ;EAChB,cAAc,EAAE,KAAK;EACrB,SAAS,EAAE,MAAM;EACjB,WAAW,EAAE,GAAG;EAChB,aAAa,EAAE,cAAc;;AAG/B,EAAG;EACD,cAAc,EAAE,KAAK;EACrB,SAAS,EAAE,MAAM;EACjB,WAAW,EAAE,KAAK;EAClB,aAAa,EAAE,cAAc;;AAG/B,EAAG;EACD,SAAS,EAAE,KAAK;EAChB,WAAW,EAAE,IAAI;;AAGnB,EAAG;EACD,SAAS,EAAE,MAAM;;AAGnB,EAAG;EACD,SAAS,EAAE,GAAG;;AAGhB,EAAG;EACD,SAAS,EAAE,GAAG;EACd,KAAK,EAAE,IAAI;;AAGb,cAAe;EACb,WAAW,EAAE,oBAAoB;EACjC,SAAS,EAAE,GAAG;;AAGhB,cAAe;EACb,WAAW,EAAE,sDAAsD;;AC5DrE,KAAM;EACJ,cAAc,EAAE,CAAC;EACjB,eAAe,EAAE,QAAQ;EAEzB,OAAO,EAAE,KAAK;EACd,KAAK,EAAE,IAAI;EACX,QAAQ,EAAE,IAAI;EACd,UAAU,EAAE,MAAM;EAClB,UAAU,EAAE,QAAQ;EAEpB,QAAG;IACD,WAAW,EAAE,IAAI;EAGnB,kBAAO;IACL,OAAO,EAAE,QAAQ;IACjB,MAAM,EAAE,cAAc;EAGxB,QAAG;IACD,gBAAgB,EAAE,IAAI;IACtB,UAAU,EAAE,cAAc;EAG5B,sBAAiB;IACf,gBAAgB,EAAE,OAAO;;ACzB7B,CAAE;EACA,4BAA4B,EAAE,OAAO;EAErC,KAAK,EAAE,OAAO;EACd,eAAe,EAAE,IAAI;EAErB,iBAAkB;IAChB,aAAa,EAAE,CAAC;IAChB,eAAe,EAAE,SAAS;EAG5B,aAAc;IACZ,KAAK,EAAE,OAAO;IACd,eAAe,EAAE,IAAI;;ACbzB,MAAO;EACL,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,CAAC;EAEhB,YAAY,EAAE,GAAG;;AAGnB,YAAa;EACX,eAAe,EAAE,WAAW;;AAG9B,sCAAuC;EACrC,eAAe,EAAE,WAAW;;AAG9B,0BAA2B;EACzB,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,CAAC;;AAGlB,EAAG;EACD,WAAW,EAAE,CAAC;;AAGhB,EAAG;EACD,OAAO,EAAE,CAAC;EAEV,KAAG;IACD,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,GAAG;IACd,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,IAAI;EAGnB,KAAG;IACD,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,IAAI;;AAIvB,MAAK;EACH,UAAU,EAAE,IAAI;;AC1ClB,IAAK;EACH,OAAO,EAAE,CAAC;EACV,WAAW,EAAE,KAAK;EAClB,cAAc,EAAE,KAAK;EACrB,MAAM,EAAE,CAAC;EAET,gBAAgB,EAAE,IAAI;EACtB,aAAa,EAAE,GAAG;EAElB,uBAAkB;IAChB,cAAc,EAAE,MAAM;IACtB,OAAO,EAAE,OAAO;;AAIpB,GAAI;EAKF,QAAQ,EAAE,IAAI;EAEd,WAAW,EAAE,IAAI;EAGjB,SAAS,EAAE,MAAM;EAEjB,UAAO;IACL,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;IACT,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,WAAW;IACvB,MAAM,EAAE,CAAC;EAGX,QAAK;IACH,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,OAAO;IAClB,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,OAAO;IACjB,WAAW,EAAE,OAAO;IACpB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,WAAW;IAC7B,MAAM,EAAE,CAAC;EAGX;gBACW;IACT,OAAO,EAAE,MAAM;;ACnDnB,eAAgB;EACd,UAAU,EAAE,IAAI;;AAGlB,aAAc;EACZ,aAAa,EAAE,CAAC;EAChB,iBAAI;IACF,aAAa,EAAE,CAAC;;ACPpB,GAAI;EACF,YAAY,EAAE,IAAI;EAElB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,WAAW;EACvB,gBAAgB,EAAE,IAAI;;ACLxB,EAAG;EACD,UAAU,EAAE,WAAW;EAEvB,QAAQ,EAAE,OAAO;EACjB,MAAM,EAAE,CAAC;EAET,QAAQ,EAAE,MAAM;EAEhB,MAAM,EAAE,CAAC;EACT,aAAa,EAAE,cAAc;EAE7B,MAAM,EAAE,GAAG;EACX,OAAO,EAAE,CAAC;EACV,MAAM,EAAE,MAAM;EACd,gBAAgB,EAAE,OAAO;EAGzB,mBAAmB,EAAE,IAAI;EAEzB,UAAU;IACR,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,EAAE;EAEb,SAAS;IACP,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,EAAE;;AC1Bf,GAAI;EACF,OAAO,EAAE,YAAY;EACrB,OAAO,EAAE,OAAO;EAChB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,KAAK,EAAE,IAAI;EACX,cAAc,EAAE,MAAM;EACtB,gBAAgB,EAAE,OAAO;EACzB,MAAM,EAAE,cAAc;EACtB,mBAAmB,EAAE,IAAI;EACzB,aAAa,EAAE,GAAG;EAClB,UAAU,EAAE,mBAAmB;;ACXjC,CAAE;EACA,UAAU,EAAE,UAAU;;AAGxB,CAAE;EACA,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,IAAI;;AAGrB,UAAW;EACT,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,MAAM;EACf,KAAK,EAAE,IAAI;EACX,WAAW,EAAE,cAAc;EAE3B,yBAAe;IACb,UAAU,EAAE,CAAC;EAGf,wBAAc;IACZ,aAAa,EAAE,CAAC;;AAIpB,qCAAsC;EACpC,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,IAAI;;ACxBrB,IAAK;EACH,SAAS,EAAE,MAAM;EACjB,MAAM,EAAE,MAAM;;AAGhB,IAAK;EACH,OAAO,EAAE,iBAAiB;EAC1B,WAAW,EAAE,KAAK;EAClB,MAAM,EAAC,cAAc;EACrB,YAAY,EAAE,KAAK;EACnB,UAAU,EAAE,KAAK;EAEjB,uBAAkB;IAChB,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,EAAE;;AAQf,YAAa;EACX,UAAU,EAAE,GAAG;EACf,aAAa,EAAE,cAAc;EAC7B,cAAE;IACA,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,KAAK;;AAIlB,GAAI;EACF,UAAU,EAAE,IAAI;EAChB,MAAM,EAAE,KAAK;EACb,KAAK,EAAE,KAAK;EACZ,UAAU,EAAE,IAAI;EAChB,QAAQ,EAAE,KAAK;EACf,OAAO,EAAE,cAAc;EACvB,YAAY,EAAE,cAAc;EAC5B,eAAQ;IAIN,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,iBAAiB;IAC1B,aAAa,EAAE,GAAG;IALlB,2BAAQ;MACN,UAAU,EAAE,OAAO;;AASzB,mBAAoB;EAClB,KAAK,EAAE,GAAG;;AAEZ,yBAA0B;EACxB,UAAU,EAAE,IAAI;EAChB,qBAAqB,EAAE,GAAG",
-"sources": ["../../styles/_typography.scss","../../styles/_table.scss","../../styles/_anchor.scss","../../styles/_list.scss","../../styles/_code.scss","../../styles/_coderay.scss","../../styles/_image.scss","../../styles/_line.scss","../../styles/_keyboard.scss","../../styles/_general.scss","../../styles/main.scss"],
+"mappings": "AAAA,IAAK;EACH,oBAAoB,EAAE,IAAI;EAC1B,wBAAwB,EAAE,IAAI;EAC9B,KAAK,EAAE,IAAI;EACX,WAAW,EAAE,8HAA8H;EAC3I,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,GAAG;EAChB,SAAS,EAAE,UAAU;;AAGvB,eAAgB;EACd,WAAW,EAAE,MAAM;;AAGrB,sBAAuB;EACrB,UAAU,EAAE,GAAG;EACf,aAAa,EAAE,IAAI;EACnB,WAAW,EAAE,IAAI;EACjB,WAAW,EAAE,GAAG;;AAGlB,EAAG;EACD,MAAM,EAAE,QAAQ;EAChB,cAAc,EAAE,KAAK;EACrB,SAAS,EAAE,MAAM;EACjB,WAAW,EAAE,GAAG;EAChB,aAAa,EAAE,cAAc;;AAG/B,EAAG;EACD,cAAc,EAAE,KAAK;EACrB,SAAS,EAAE,MAAM;EACjB,WAAW,EAAE,KAAK;EAClB,aAAa,EAAE,cAAc;;AAG/B,EAAG;EACD,SAAS,EAAE,KAAK;EAChB,WAAW,EAAE,IAAI;;AAGnB,EAAG;EACD,SAAS,EAAE,MAAM;;AAGnB,EAAG;EACD,SAAS,EAAE,GAAG;;AAGhB,EAAG;EACD,SAAS,EAAE,GAAG;EACd,KAAK,EAAE,IAAI;;AAGb,cAAe;EACb,WAAW,EAAE,oBAAoB;EACjC,SAAS,EAAE,GAAG;;AAGhB,cAAe;EACb,WAAW,EAAE,sDAAsD;;AC5DrE,KAAM;EACJ,cAAc,EAAE,CAAC;EACjB,eAAe,EAAE,QAAQ;EAEzB,OAAO,EAAE,KAAK;EACd,KAAK,EAAE,IAAI;EACX,QAAQ,EAAE,IAAI;EACd,UAAU,EAAE,MAAM;EAClB,UAAU,EAAE,QAAQ;EAEpB,QAAG;IACD,WAAW,EAAE,IAAI;EAGnB,kBAAO;IACL,OAAO,EAAE,QAAQ;IACjB,MAAM,EAAE,cAAc;EAGxB,QAAG;IACD,gBAAgB,EAAE,IAAI;IACtB,UAAU,EAAE,cAAc;EAG5B,sBAAiB;IACf,gBAAgB,EAAE,OAAO;;ACzB7B,CAAE;EACA,4BAA4B,EAAE,OAAO;EAErC,KAAK,EAAE,OAAO;EACd,eAAe,EAAE,IAAI;EAErB,iBAAkB;IAChB,aAAa,EAAE,CAAC;IAChB,eAAe,EAAE,SAAS;EAG5B,aAAc;IACZ,KAAK,EAAE,OAAO;IACd,eAAe,EAAE,IAAI;;ACbzB,MAAO;EACL,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,CAAC;EAEhB,YAAY,EAAE,GAAG;;AAGnB,YAAa;EACX,eAAe,EAAE,WAAW;;AAG9B,sCAAuC;EACrC,eAAe,EAAE,WAAW;;AAG9B,0BAA2B;EACzB,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,CAAC;;AAGlB,EAAG;EACD,WAAW,EAAE,CAAC;;AAGhB,EAAG;EACD,OAAO,EAAE,CAAC;EAEV,KAAG;IACD,OAAO,EAAE,CAAC;IACV,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,GAAG;IACd,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,IAAI;EAGnB,KAAG;IACD,OAAO,EAAE,MAAM;IACf,aAAa,EAAE,IAAI;;AAIvB,MAAK;EACH,UAAU,EAAE,IAAI;;AC1ClB,IAAK;EACH,OAAO,EAAE,CAAC;EACV,WAAW,EAAE,KAAK;EAClB,cAAc,EAAE,KAAK;EACrB,MAAM,EAAE,CAAC;EAET,gBAAgB,EAAE,IAAI;EACtB,aAAa,EAAE,GAAG;EAElB,uBAAkB;IAChB,cAAc,EAAE,MAAM;IACtB,OAAO,EAAE,OAAO;;AAIpB,GAAI;EAKF,QAAQ,EAAE,IAAI;EAEd,WAAW,EAAE,IAAI;EAGjB,SAAS,EAAE,MAAM;EAEjB,UAAO;IACL,OAAO,EAAE,CAAC;IACV,MAAM,EAAE,CAAC;IACT,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,WAAW;IACvB,MAAM,EAAE,CAAC;EAGX,QAAK;IACH,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,MAAM;IACf,SAAS,EAAE,OAAO;IAClB,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,OAAO;IACjB,WAAW,EAAE,OAAO;IACpB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,WAAW;IAC7B,MAAM,EAAE,CAAC;EAGX;gBACW;IACT,OAAO,EAAE,MAAM;;ACnDnB,eAAgB;EACd,UAAU,EAAE,IAAI;;AAGlB,aAAc;EACZ,aAAa,EAAE,CAAC;EAChB,iBAAI;IACF,aAAa,EAAE,CAAC;;ACPpB,GAAI;EACF,YAAY,EAAE,IAAI;EAElB,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,WAAW;EACvB,gBAAgB,EAAE,IAAI;;ACLxB,EAAG;EACD,UAAU,EAAE,WAAW;EAEvB,QAAQ,EAAE,OAAO;EACjB,MAAM,EAAE,CAAC;EAET,QAAQ,EAAE,MAAM;EAEhB,MAAM,EAAE,CAAC;EACT,aAAa,EAAE,cAAc;EAE7B,MAAM,EAAE,GAAG;EACX,OAAO,EAAE,CAAC;EACV,MAAM,EAAE,MAAM;EACd,gBAAgB,EAAE,OAAO;EAGzB,mBAAmB,EAAE,IAAI;EAEzB,UAAU;IACR,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,EAAE;EAEb,SAAS;IACP,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,EAAE;;AC1Bf,GAAI;EACF,OAAO,EAAE,YAAY;EACrB,OAAO,EAAE,OAAO;EAChB,SAAS,EAAE,IAAI;EACf,WAAW,EAAE,IAAI;EACjB,KAAK,EAAE,IAAI;EACX,cAAc,EAAE,MAAM;EACtB,gBAAgB,EAAE,OAAO;EACzB,MAAM,EAAE,cAAc;EACtB,mBAAmB,EAAE,IAAI;EACzB,aAAa,EAAE,GAAG;EAClB,UAAU,EAAE,mBAAmB;;ACXjC,YAAa;EACX,aAAa,EAAE,IAAI;;AAGrB,aAAc;EACZ,OAAO,EAAE,IAAI;EACb,OAAO,EAAE,QAAQ;EACjB,SAAS,EAAE,KAAK;EAChB,KAAK,EAAE,GAAG;EACV,SAAS,EAAE,KAAK;EAEhB,MAAM,EAAE,cAAc;EACtB,aAAa,EAAE,GAAG;EAElB,mBAAQ;IACN,YAAY,EAAE,OAAO;;ACfzB,CAAE;EACA,UAAU,EAAE,UAAU;;AAGxB,CAAE;EACA,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,IAAI;;AAGrB,UAAW;EACT,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,MAAM;EACf,KAAK,EAAE,IAAI;EACX,WAAW,EAAE,cAAc;EAE3B,yBAAe;IACb,UAAU,EAAE,CAAC;EAGf,wBAAc;IACZ,aAAa,EAAE,CAAC;;AAIpB,qCAAsC;EACpC,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,IAAI;;ACxBrB,IAAK;EACH,SAAS,EAAE,MAAM;EACjB,MAAM,EAAE,MAAM;;AAGhB,IAAK;EACH,OAAO,EAAE,iBAAiB;EAC1B,WAAW,EAAE,KAAK;EAClB,MAAM,EAAC,cAAc;EACrB,YAAY,EAAE,KAAK;EACnB,UAAU,EAAE,KAAK;EAEjB,uBAAkB;IAChB,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,EAAE;;AAQf,YAAa;EACX,UAAU,EAAE,GAAG;EACf,aAAa,EAAE,cAAc;EAC7B,cAAE;IACA,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,KAAK;;AAIlB,GAAI;EACF,UAAU,EAAE,IAAI;EAChB,MAAM,EAAE,KAAK;EACb,KAAK,EAAE,KAAK;EACZ,UAAU,EAAE,IAAI;EAChB,QAAQ,EAAE,KAAK;EACf,OAAO,EAAE,cAAc;EACvB,YAAY,EAAE,cAAc;EAC5B,eAAQ;IAIN,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,iBAAiB;IAC1B,aAAa,EAAE,GAAG;IALlB,2BAAQ;MACN,UAAU,EAAE,OAAO;;AASzB,mBAAoB;EAClB,KAAK,EAAE,GAAG;;AAEZ,yBAA0B;EACxB,UAAU,EAAE,IAAI;EAChB,qBAAqB,EAAE,GAAG",
+"sources": ["../../styles/_typography.scss","../../styles/_table.scss","../../styles/_anchor.scss","../../styles/_list.scss","../../styles/_code.scss","../../styles/_coderay.scss","../../styles/_image.scss","../../styles/_line.scss","../../styles/_keyboard.scss","../../styles/_search.scss","../../styles/_general.scss","../../styles/main.scss"],
 "names": [],
 "file": "main.css"
 }

data/app/styles/_general.scss

@@ -27,14 +27,3 @@ p, blockquote, ul, ol, dl, table, pre {
   margin-bottom: 16px;
 }
 
-// &:before {
-//   display: table;
-//   content: "";
-// }
-
-// &:after {
-//   display: table;
-//   clear: both;
-//   content: "";
-// }
-

data/app/styles/_manifest.scss

@@ -7,6 +7,7 @@
 @import "image";
 @import "line";
 @import "keyboard";
+@import "search";
 
 // Last
 @import "general";

data/app/styles/_search.scss

@@ -0,0 +1,22 @@
+.search-form {
+  margin-bottom: 20px;
+}
+
+.search-field {
+  outline: none;
+  padding: 8px 12px;
+  font-size: 1.5em;
+  width: 50%;
+  min-width: 200px;
+
+  border: #ccc 1px solid;
+  border-radius: 3px;
+
+  &:focus {
+    border-color: #4078c0;
+  }
+}
+
+.highlight {
+  // background: #fda;
+}

data/app/views/_nav.slim

@@ -1,5 +1,7 @@
 nav
-  a.strong href="/" Home
+  a.strong href="/" accesskey='h' Home
+  - if nav.with_search?
+    a.strong href="/_search" accesskey='s' Search
   
   - if nav.caption
     span.strong = "#{nav.caption}:"

data/app/views/search.slim

@@ -0,0 +1,23 @@
+== slim :_nav, locals: { nav: nav }
+
+main
+  h1 Search
+
+  form.search-form action="/_search" method="get"
+    input.search-field type="text" name="q" value="#{params[:q]}" placeholder="Enter search query" autofocus=true
+    input type="submit" value="Search" style='display:none'
+
+  hr
+
+  - if results
+    - results.each_with_index do |result, index|
+      h4
+        = index+1
+        = ". "
+        a href="#{result[:file]}" = result[:label]
+        
+      - if result[:highlights]
+        - result[:highlights].each do |highlight|
+          p == highlight
+
+

data/lib/madness.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'singleton'
 require 'yaml'
 
@@ -11,6 +12,7 @@ require 'sass/plugin/rack'
 require 'docopt'
 require 'colsole'
 require 'rack/contrib/try_static'
+require 'ferret'
 
 require 'madness/version'
 require 'madness/settings'
@@ -21,4 +23,5 @@ require 'madness/document'
 require 'madness/navigation'
 require 'madness/breadcrumbs'
 require 'madness/command_line'
+require 'madness/search'
 

data/lib/madness/command_line.rb

@@ -24,7 +24,11 @@ module Madness
       begin
         args = Docopt::docopt(doc, argv: argv, version: VERSION)
         set_config args
-        launch_server
+        if args['--index']
+          build_index
+        else
+          launch_server
+        end
       rescue Docopt::Exit => e
         puts e.message
       end
@@ -65,6 +69,12 @@ module Madness
       say "-" * 40
     end
 
+    def build_index
+      say_status :start, 'indexing'
+      Search.new.build_index
+      say_status :done, 'indexing'
+    end
+
     def config
       @config ||= Settings.instance
     end

data/lib/madness/docopt.txt

@@ -26,7 +26,11 @@ Options:
   --no-line-numbers
     Disable line numbering for syntax highlighter.
 
+  --index
+    Build or rebuild the index for the search page.
+
 Examples:
   madness
   madness docs
   madness docs --no-auto-h1 -p 4567
+

data/lib/madness/document.rb

@@ -39,7 +39,7 @@ module Madness
     # Return the HTML for that document, force re-read.
     def content!
       if File.exist?(file)
-        html = markdown_to_html html
+        markdown_to_html
       else
         @type = :empty
         ""
@@ -61,7 +61,7 @@ module Madness
     # Convert markdown to HTML, wit hsome additional processing:
     # 1. Syntax highilghting
     # 2. Prepend H1 if needed
-    def markdown_to_html(html)
+    def markdown_to_html
       html = RDiscount.new(File.read file).to_html
       html = syntax_highlight(html) if config.highlighter
       html = prepend_h1(html) if config.autoh1

data/lib/madness/navigation.rb

@@ -7,7 +7,12 @@ module Madness
 
     def initialize(dir)
       @links = make_links dir
-      @caption = File.basename(dir) unless dir == docroot
+      # @caption = File.basename(dir) unless dir == docroot
+      @caption = dir == docroot ? "Index" : File.basename(dir)
+    end
+
+    def with_search?
+      @with_search ||= Search.new.has_index?
     end
 
     private

data/lib/madness/search.rb

@@ -0,0 +1,61 @@
+module Madness
+
+  class Search
+    include ServerHelper
+    include Ferret
+    include Ferret::Index
+
+    def initialize(path=nil)
+      @path = path || docroot
+    end
+
+    def has_index?
+      Dir.exist? index_dir
+    end
+
+    def build_index
+      Dir.mkdir index_dir unless Dir.exist? index_dir
+
+      index = Index.new path: index_dir, create: true
+
+      Dir["#{@path}/**/*.md"].each do |file|
+        index << { file: file, content: File.read(file) }
+      end
+
+      index.optimize()                                
+      index.close()
+    end
+
+    def search(query)
+      index = Index.new path: index_dir
+
+      results = []
+      total_hits = index.search_each(query, limit: 20) 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 class='highlight'>", post_tag: "</strong>",
+          excerpt_length: 100
+
+        results << { 
+          score: score, 
+          file: filename,
+          label: filename.gsub("/", " / "),
+          highlights: highlights
+        }
+      end
+
+      index.close()
+      results
+    end
+
+    def remove_index_dir
+      return unless Dir.exist? index_dir
+      FileUtils.rm_r index_dir
+    end
+
+    def index_dir
+      "#{@path}/_index"
+    end  
+
+  end
+end

data/lib/madness/server.rb

@@ -4,6 +4,16 @@ module Madness
 
   # The Sinatra server
   class Server < ServerBase
+    get '/_search' do
+      query = params[:q]
+      results = query ? Search.new.search(query) : false
+      nav = Navigation.new docroot
+      slim :search, locals: {
+        nav: nav,
+        results: results
+      }
+    end
+
     get '/*' do
       path = params[:splat].first
 

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: ferret
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +282,7 @@ files:
 - app/styles/_line.scss
 - app/styles/_list.scss
 - app/styles/_manifest.scss
+- app/styles/_search.scss
 - app/styles/_table.scss
 - app/styles/_typography.scss
 - app/styles/main.scss
@@ -277,6 +292,7 @@ files:
 - app/views/_nav.slim
 - app/views/document.slim
 - app/views/layout.slim
+- app/views/search.slim
 - bin/madness
 - lib/madness.rb
 - lib/madness/breadcrumbs.rb
@@ -284,6 +300,7 @@ files:
 - lib/madness/docopt.txt
 - lib/madness/document.rb
 - lib/madness/navigation.rb
+- lib/madness/search.rb
 - lib/madness/server.rb
 - lib/madness/server_base.rb
 - lib/madness/server_helper.rb