mirror of
https://github.com/middleman/middleman.git
synced 2022-11-09 12:20:27 -05:00
144 lines
5.4 KiB
Ruby
Executable file
144 lines
5.4 KiB
Ruby
Executable file
# 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)
|
|
# * Slim (.slim)
|
|
# * 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"
|
|
autoload :Slim, "middleman/renderers/slim"
|
|
autoload :Markdown, "middleman/renderers/markdown"
|
|
autoload :CoffeeScript, "middleman/renderers/coffee_script"
|
|
end
|
|
|
|
module CoreExtensions
|
|
# Custom Feature API
|
|
autoload :Features, "middleman/core_extensions/features"
|
|
|
|
# Asset Path Pipeline
|
|
autoload :Assets, "middleman/core_extensions/assets"
|
|
|
|
# DefaultHelpers are the built-in dynamic template helpers.
|
|
autoload :DefaultHelpers, "middleman/core_extensions/default_helpers"
|
|
|
|
# Data looks at the data/ folder for YAML files and makes them available
|
|
# to dynamic requests.
|
|
autoload :Data, "middleman/core_extensions/data"
|
|
|
|
# Parse YAML from templates
|
|
autoload :FrontMatter, "middleman/core_extensions/front_matter"
|
|
|
|
# Extended version of Padrino's rendering
|
|
autoload :Rendering, "middleman/core_extensions/rendering"
|
|
end
|
|
|
|
module Features
|
|
# RelativeAssets allow any asset path in dynamic templates to be either
|
|
# relative to the root of the project or use an absolute URL.
|
|
autoload :RelativeAssets, "middleman/features/relative_assets"
|
|
|
|
# AssetHost allows you to setup multiple domains to host your static assets.
|
|
# Calls to asset paths in dynamic templates will then rotate through each of
|
|
# the asset servers to better spread the load.
|
|
autoload :AssetHost, "middleman/features/asset_host"
|
|
|
|
# CacheBuster adds a query string to assets in dynamic templates to avoid
|
|
# browser caches failing to update to your new content.
|
|
autoload :CacheBuster, "middleman/features/cache_buster"
|
|
|
|
# AutomaticImageSizes inspects the images used in your dynamic templates and
|
|
# automatically adds width and height attributes to their HTML elements.
|
|
autoload :AutomaticImageSizes, "middleman/features/automatic_image_sizes"
|
|
|
|
# UglyHaml enables the non-indented output format from Haml templates. Useful
|
|
# for somewhat obfuscating the output and hiding the fact that you're using Haml.
|
|
autoload :UglyHaml, "middleman/features/ugly_haml"
|
|
|
|
# MinifyCss uses the YUI compressor to shrink CSS files
|
|
autoload :MinifyCss, "middleman/features/minify_css"
|
|
|
|
# MinifyJavascript uses the YUI compressor to shrink JS files
|
|
autoload :MinifyJavascript, "middleman/features/minify_javascript"
|
|
|
|
# CodeRay is a syntax highlighter.
|
|
autoload :CodeRay, "middleman/features/code_ray"
|
|
|
|
# Lorem provides a handful of helpful prototyping methods to generate words,
|
|
# paragraphs, fake images, names and email addresses.
|
|
autoload :Lorem, "middleman/features/lorem"
|
|
|
|
# Treat project as a blog
|
|
autoload :Blog, "middleman/features/blog"
|
|
|
|
# Proxy web services requests in dev mode only
|
|
autoload :Proxy, "middleman/features/proxy"
|
|
|
|
# Automatically resize images for mobile devises
|
|
# autoload :TinySrc, "middleman/features/tiny_src"
|
|
|
|
# LiveReload will auto-reload browsers with the live reload extension installed after changes
|
|
# Currently disabled and untested.
|
|
# autoload :LiveReload, "middleman/features/live_reload"
|
|
end
|
|
end
|