README.textile in henrik-jekyll-0.5.1 vs README.textile in henrik-jekyll-0.5.2

- old
+ new

@@ -1,7 +1,11 @@ h1. Jekyll +By Tom Preston-Werner, Nick Quaranto, and many awesome contributors! + +h2. Description + Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. Visit "http://tom.preston-werner.com":http://tom.preston-werner.com to see an @@ -170,15 +174,27 @@ To transform ".haml":http://github.com/nex3/haml/tree/master files to HTML (e.g. '/about.haml' will generate '/about.html'): $ jekyll --haml -Note that files must have a YAML metadata block at the top to be converted, -and that Haml cannot currently be used for layouts -- only posts and pages. +Note that pages and posts must have a YAML metadata block at the top to be +converted. Layouts don't need to. Haml content is intentionally not filtered, so you can use any Ruby code. +If you want to define methods you can call from your Haml files, create +a _helpers.rb file in the root of your blog and put the methods there, +inside a module named Helpers. + +Jekyll provides some helpers out of the box: + + h(string) + HTML entity-escapes the input string. + + link_to(text, url) + Creates a link to the URL with the linked text (or markup). + h3. Local Server When previewing complex sites locally, simply opening the site in a web browser (using file://) can cause problems with links that are relative to the site root (e.g., "/stylesheets/style.css"). To get around this, Jekyll @@ -203,24 +219,20 @@ change the permalink style to 'pretty' and directories corresponding to the date parts and post name will be made and an index.html will be placed in the leaf directory resulting in URLs like 2008/11/17/blogging-like-a-hacker/. $ jekyll --permalink [date|none|pretty] - -h3. Permalink Date Format -By default, unless you set the --permalink option to 'none', permalinks begin -with the date in a 'YYYY/MM/DD' format. +Another way to leave off the .html is to configure Apache with 'Options +MultiViews'. +Just link to pages without the extension (and without a trailing slash, like '/about'). +Then tell Jekyll not to add '.html' when linking to blog posts, like so: -To customize this format, pass --permalink-date a strftime type format string. - - $ jekyll --permalink-date [format string] + $ jekyll --multiviews -For example, to use only the year and month in the slug: +Note that this has no effect with '--permalink pretty' since that makes an index.html +file in a directory. - $ jekyll --permalink-date %Y/%m - h2. Configuration File All of the options listed above can be specified on a site-by-site basis in a '_config.yml' file at the root of the site's source. As the filename suggests, the configuration is given in "YAML":http://www.yaml.org/. As @@ -267,13 +279,12 @@ h2. Data Jekyll traverses your site looking for files to process. Any files with YAML front matter (see below) are subject to processing. For each of these files, -Jekyll makes a variety of data available to the pages via Haml (regular pages -only) or the Liquid templating system. The following is a reference of the -available data. +Jekyll makes a variety of data available to the pages via Haml or the Liquid +Liquid templating system. The following is a reference of the available data. h3. Global site Sitewide information. @@ -608,10 +619,10 @@ # Add tests and make sure everything still passes by running `rake` # If you are adding new functionality, document it in README.textile # Do not change the version number, I will do that on my end # If necessary, rebase your commits into logical chunks, without errors # Push the branch up to GitHub -# Send me (mojombo) a pull request for your branch +# Create an issue on mojombo/grit with a description and link to your branch h2. License (The MIT License)