docface 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzE1N2UwNjNlZjFhNGFlMjQzZmFjN2EwMTZlMGMzMDJkNGJiYjlhZg==
+    MzI4MGRiODI4Y2I1ZTBlMDAwZDdhMjA4Mzk5MWEwMjJiOTMxMzlkYQ==
   data.tar.gz: !binary |-
-    NTIzNzYxYjlmNDExYjVkMmJiNjMwMDFkNGYwNWYwZDU1NDJkYmU5NQ==
+    NmI5NTI4YzRhOWY3YzAxZDQ4M2EyZTg5ZmM2ZmIzM2M0MDlkMGZjMw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZTEwZjc5N2M4ZmYwZWJkZTVmYzk3OGM5ZmM0YjQzZjA2N2JkMDNmMzVhNDM3
-    MmM3ZjRlNjI4ZjkzYzQwNGY5OTk3MWQ4ODk4NTk4MTNiZjQzYTAxODc3ZTA4
-    NjM3ODJhZjAyYjE4NmFjMGM0ZjI3ZWVlMDliZmM5Mjk1NjlhYjY=
+    ODQzNTU2Yjc4OWM4Y2JiMDZmYWQwMTMxODFkZTYzMzFjZGM3OWQyMTIxNzQ5
+    ZGZjZTRjMjUzNjgwNTZjNTQxYjFlN2MwMDcyYjNjMjg4MGJlMzg4MThiZTBm
+    NzNlYzI0YzkzYzhlYjMxOWQ5ODY3ZjlkM2I5NGY0NGIyMDhjYWQ=
   data.tar.gz: !binary |-
-    ZWUxZWY3ZDIxOWNmZmYxYmYzNGM1MDU4ZWIwZmMyYjhjZmUxOGQxMDJiYTZl
-    YjE3ZGVlNjA4MTFmNWNmOTNlMzc0ZmIzZjhhOGMxYjE0Nzg2ODQ1NWVkNWMz
-    NmQwMmNkYWFmMTgyZjRkYjU0OWZkYjExZWE1OGE2NTVlMTczZTg=
+    ZDhlNDE3OTMzMTg5MDQwMGYzZDZiOGU5N2JhMDNhZGNiZTIxNGFjMWFmYjE3
+    ODcxMjdhMjg1NThlOTRhMDkxZmQzZTFiNzY0N2EwZDcyNzg2ZmQ3OWFjMmZl
+    YTAwZjU4ZjE1MWQ2YzE0ZWIzNjU2YjJjNzYwZWVlZTJlNTc0NTE=

data/README.md

@@ -1,13 +1,14 @@
 DocFace
 =========
-DocFace turns your markdown files into html and makes them easy to view via a web page.
+DocFace turns your markdown files into html and makes them easy to view via a web page.  It will recursively look through the directories you specify and will build navigation in the directory heirarchy that it discovered the files in.
 
 I mainly created DocFace because I use Opscode Chef and you end up with tons of README and CHANGELOG files.  I wanted to view these is some sane way.
 
 <img src="https://raw.github.com/agent462/docface/downloads/screenshot.png" title="docface screenshot" />
 Installation
 -----------------------
-~~~~
+
+~~~~ ruby
 gem install docface
 ~~~~
 
@@ -19,13 +20,23 @@ gem build docface.gemspec
 Usage
 -----------------------
 ~~~~
-docface -d ~/git/chef
 docface -d ~/git/chef -o ~/my_docs
 ~~~~
 
+* For multiple directories include them seperated by a space
+
+~~~~
+docface -d ~/git/chef/cookbooks ~/git/chef/site-cookbooks 
+~~~~
+
+Known Issues
+------------
+* Running locally and using Chrome?  You're going to have a "same origin policy" issue.  You can either put a webserver in front of it, use FireFox or try running Chrome with "--allow-file-access-from-files".  Chrome prevents ajax calls to local files.
+
 Table of Contents
 -----------------
 Want a table of contents on your pages?  Include the following snippet in your markdown file wherever you want the TOC.
+
 ~~~~
 * This will be replaced with the ToC
 {:toc}

data/docface.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Bryan Brandau"]
   s.email       = 'agent462@gmail.com'
   s.has_rdoc    = false
+  s.licenses    = ['APACHE']
 
   s.homepage    ='http://github.com/agent462/docface'
   s.add_dependency('rainbow', '1.1.4')

data/lib/docface/base.rb

@@ -30,7 +30,10 @@ module DocFace
     def cli
       @cli = Cli.opts
       @directory = @cli[:dir]
-      @title = @cli[:title] || "DocFace"
+      @page_attributes = {
+        :title => @cli[:title] || "DocFace",
+        :summary => @cli[:summary] || ""
+      }
       @output_dir = @cli[:output] ? @cli[:output] : "#{Dir.pwd}/docface"
     end
 
@@ -45,7 +48,7 @@ module DocFace
     end
 
     def build(file,content)
-      file = File.join(@output_dir,file).gsub(/\.md/,".html")
+      file = File.join(@output_dir,file).gsub(/\.md|.MD|.markdown|.mdown/,".html")
       directory = File.dirname(file)
       @writer.write(directory,file,content)
     end

data/lib/docface/cli.rb

@@ -27,13 +27,14 @@ module DocFace
         EOS
         banner <<-EOS.gsub(/^ {10}/, '').color(:cyan)
 
-          Example Usage: docface -d ~/git/chef -o ~/my_build
+          Example Usage: docface -d ~/git/chef/cookbooks ~/git/chef/site-cookbooks  -o ~/my_build
           For help use: docface --help
         EOS
-        opt :dir, "The directories to scan for markdown files", :short => "d", :type => :strings, :required => true
+        opt :dir, "The directories to scan for markdown files. For multiple directories, separate each directory with a space.", :short => "d", :type => :strings, :required => true
         opt :output, "The directory to write the generated output to", :short => "o", :type => :string
         opt :title, "The title of the page", :short => "t", :type => :string
-        opt :description, "A custom description for the page", :short => "D", :type => :string
+        opt :summary, "A custom summary for the page", :short => "s", :type => :string
+        opt :wide, "Pass this parameter if you need a wider nav", :short => "w"
       end
 
       opts = Trollop::with_standard_exception_handling p do

data/lib/docface/file_troll.rb

@@ -5,7 +5,7 @@ module DocFace
       if File.directory?(dir)
         index = Array.new
         path = dir.gsub(/\\(?=\S)/, '/')
-        Dir.glob(File.join(path, '**/*.md')).each do |file|
+        Dir.glob(File.join(path, '**/*.{md,MD,markdown,mdown}')).each do |file|
           index << file
         end
         index

data/lib/docface/templates/center.erb

@@ -1,8 +1,8 @@
-    <div class="span9">
-      <div id="center-container" class="well">
-            <h1><%= @title %></h1>
-            <p></p>
+    <div class="span<%= @cli[:wide] ? "9" : "10"%>">
+      <div id="center-container">
+            <h1><%= @page_attributes[:title] %></h1>
+            <p><span class="label label-info"><%= @short_files.count %></span> parsed markdown files. </p>
+            <p><%= @page_attributes[:summary] %></p>
       </div>
     </div>
   </div><!--/row -->
-</div><!--/containter-->

data/lib/docface/templates/footer.erb

@@ -1,3 +1,9 @@
+      <hr>
+  <footer>
+    <p>documentation generated by <a href="http://github.com/agent462/docface">DocFace</a></p>
+  </footer>
+</div><!--/containter-->
+
   <script type="text/javascript" src="public/js/jquery-2.0.0.min.js"></script>
   <script type="text/javascript" src="public/js/bootstrap.min.js"></script>
   <script type="text/javascript">

data/lib/docface/templates/header.erb

@@ -1,7 +1,7 @@
 <html><head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <title><%= @title %></title>
+  <title><%= @page_attributes[:title] %></title>
   <link rel="stylesheet" href="public/css/bootstrap.min.css">
   <link rel="stylesheet" href="public/css/doc.css">
     <style type="text/css">

data/lib/docface/templates/nav.erb

@@ -6,8 +6,8 @@ def create_nav(h,path="")
   return if h == nil
   h.each do |k,v|
     @i += 1
-    if k.end_with?("md")
-      html_path = k.gsub(/md/, 'html')
+    if k.end_with?(".md") || k.end_with?(".MD") || k.end_with?(".markdown") || k.end_with?(".mdown")
+      html_path = k.gsub(/.md|.MD|.markdown|.mdown/, '.html')
       @str << "<ul class='nav nav-list'><li><a href=\"#\" res=\"#{path}/#{html_path}\">#{k}</a></li></ul>"
     else
       ## Accordion Header
@@ -38,7 +38,7 @@ end
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
-      <a class="brand" href="#"><%= @title %></a>
+      <a class="brand" href="#"><%= @page_attributes[:title] %></a>
       <div class="nav-collapse collapse">
         <ul class="nav">
           <li class="active"><a href="/">Home</a></li>
@@ -49,8 +49,8 @@ end
 </div>
 <div class="container-fluid">
   <div class="row-fluid">
-    <div class="span3">
-      <div class="well sidebar-nav">
+    <div class="span<%= @cli[:wide] ? "3" : "2"%>">
+      <div class="sidebar-nav">
         <div class='accordion'>
           <% @index_hash.each do |k,v| %>
             <div class='accordion-group'>

data/lib/docface/version.rb

@@ -1,3 +1,3 @@
 module DocFace
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/public/css/doc.css

@@ -6,7 +6,7 @@ h2 {
     font-size: 1.5em;
     padding-top: 1.2em;
     margin: 1em 0 1em;
-    border-top: 1px solid #ddd;
+    border-top: 2px solid #ddd;
 }
 
 h3 {
@@ -18,3 +18,15 @@ p {
     line-height:1.5em;
     margin: 1em 0 1.5em;
 }
+
+.accordion .accordion-toggle {
+  padding: 8px 8px;
+}
+
+pre {
+  background-color: rgb(0, 0, 0);
+  color: rgb(248, 248, 248);
+  font-family: monospace;
+  font-size: 14px;
+  width: 800px;
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docface
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Bryan Brandau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -97,7 +97,8 @@ files:
 - docface.gemspec
 - README.md
 homepage: http://github.com/agent462/docface
-licenses: []
+licenses:
+- APACHE
 metadata: {}
 post_install_message: 
 rdoc_options: []