From 3a333c37beba99f2de6e099a1dffaecdaacb7004 Mon Sep 17 00:00:00 2001 From: tdreyno Date: Thu, 10 Feb 2011 23:14:33 -0800 Subject: [PATCH] Initial docs --- Rakefile | 6 ++ docs/lib/middleman.html | 168 ++++++++++++++++++++++++++++++++++++++++ lib/middleman.rb | 59 ++++++++++++++ 3 files changed, 233 insertions(+) create mode 100644 docs/lib/middleman.html diff --git a/Rakefile b/Rakefile index b4b77f9e..26fdde37 100644 --- a/Rakefile +++ b/Rakefile @@ -8,3 +8,9 @@ Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t| end task :test => :cucumber + +namespace :build do + task :docs do + `rocco lib/*.rb --output=docs` + end +end \ No newline at end of file diff --git a/docs/lib/middleman.html b/docs/lib/middleman.html new file mode 100644 index 00000000..12cc3792 --- /dev/null +++ b/docs/lib/middleman.html @@ -0,0 +1,168 @@ + + + + + middleman.rb + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

middleman.rb

+
+ # +
+

Middleman is a static site renderer that provides all the conveniences of + a modern web stack, like Ruby on Rails, while remaining focused on building + the fastest, most-professional sites possible

+ +

Install Middleman:

+ +
 gem install middleman
+
+ +

To accomplish its goals, Middleman supports provides access to:

+ +

Command-line tools:

+ +
    +
  • mm-init: A tool for creating to new static sites.
    • +
  • mm-server: A tool for rapidly developing your static site.
    • +
  • mm-build: A tool for exporting your site into optimized HTML, CSS & JS.
    • +
+ + +

Tons of templating languages including:

+ +
    +
  • ERB (.erb)
    • +
  • Interpolated String (.str)
    • +
  • Sass (.sass)
    • +
  • Scss (.scss)
    • +
  • Haml (.haml)
    • +
  • Sass (.sass)
    • +
  • Less CSS (.less)
    • +
  • Builder (.builder)
    • +
  • Liquid (.liquid)
    • +
  • RDiscount (.markdown)
    • +
  • RedCloth (.textile)
    • +
  • RDoc (.rdoc)
    • +
  • Radius (.radius)
    • +
  • Markaby (.mab)
    • +
  • Nokogiri (.nokogiri)
    • +
  • Mustache (.mustache)
    • +
  • CoffeeScript (.coffee)
    • +
+ + +

Compile-time Optimiztions

+ +
    +
  • Javascript Minifiers: YUI, Google Closure & UglifyJS
    • +
  • Smush.it Image Compression
    • +
  • CSS Minification
    • +
+ + +

Robust Extensions:

+ +

Add your own runtime and build-time features!

+ +

Next Steps:

+ + + 		+ 

+      

+        

+          #
+        

+        
 Setup out load paths

+      		
+        
libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)

+      

+        

+          #
+        

+        
 Require Rubygems (probably not necessary)

+      		
+        
require 'rubygems'

+      

+        

+          #
+        

+        
 Top-level Middleman object

+      		
+        
module Middleman

+      

+        

+          #
+        

+        
 Auto-load modules on-demand

+      		
+        
  autoload :Server, "middleman/server"
+  

+      

+        

+          #
+        

+        
 Custom Renderers

+      		
+        
  module Renderers
+    autoload :Haml, "middleman/renderers/haml"
+    autoload :Sass, "middleman/renderers/sass"
+  end

+      

+        

+          #
+        

+        
 Features API

+
+      		
+        
  autoload :Features, "middleman/features"
+end

+      

+

+
diff --git a/lib/middleman.rb b/lib/middleman.rb
index fc83e5a6..a105a77a 100755
--- a/lib/middleman.rb
+++ b/lib/middleman.rb
@@ -1,15 +1,74 @@
+# Middleman is a static site renderer that provides all the conveniences of
+# a modern web stack, like Ruby on Rails, while remaining focused on building
+# the fastest, most-professional sites possible
+#
+# Install Middleman:
+#
+#     gem install middleman
+#
+# To accomplish its goals, Middleman supports provides access to:
+# 
+#### Command-line tools:
+# * **mm-init**: A tool for creating to new static sites.
+# * **mm-server**: A tool for rapidly developing your static site.
+# * **mm-build**: A tool for exporting your site into optimized HTML, CSS & JS.
+#
+#### Tons of templating languages including:
+# * ERB                        (.erb)
+# * Interpolated String        (.str)
+# * Sass                       (.sass)
+# * Scss                       (.scss)
+# * Haml                       (.haml)
+# * Sass                       (.sass)
+# * Less CSS                   (.less)
+# * Builder                    (.builder)
+# * Liquid                     (.liquid)
+# * RDiscount                  (.markdown)
+# * RedCloth                   (.textile)
+# * RDoc                       (.rdoc)
+# * Radius                     (.radius)
+# * Markaby                    (.mab)
+# * Nokogiri                   (.nokogiri)
+# * Mustache                   (.mustache)
+# * CoffeeScript               (.coffee)
+#
+#### Compile-time Optimiztions
+# * Javascript Minifiers: YUI, Google Closure & UglifyJS
+# * Smush.it Image Compression
+# * CSS Minification
+#
+#### Robust Extensions:
+# Add your own runtime and build-time features!
+#
+#### Next Steps:
+# * [Visit the website]
+# * [Read the wiki]
+# * [Email the users group]
+# * [Submit bug reports]
+#
+# [Visit the website]:     http://middlemanapp.com
+# [Read the wiki]:         https://github.com/tdreyno/middleman/wiki
+# [Email the users group]: http://groups.google.com/group/middleman-users
+# [Submit bug reports]:    https://github.com/tdreyno/middleman/issues
+
+# Setup out load paths
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
+# Require Rubygems (probably not necessary)
 require 'rubygems'
 
+# Top-level Middleman object
 module Middleman
+  # Auto-load modules on-demand
   autoload :Server, "middleman/server"
   
+  # Custom Renderers
   module Renderers
     autoload :Haml, "middleman/renderers/haml"
     autoload :Sass, "middleman/renderers/sass"
   end
 
+  # Features API
   autoload :Features, "middleman/features"
 end