From 732c213803d01a42e193071771fabe774733026a Mon Sep 17 00:00:00 2001 From: Jonathan Allard Date: Tue, 9 Jan 2018 18:41:57 -0500 Subject: [PATCH] Readme: Add empty front-matter caveat --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0a9d12c..29afcbf 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ gems: You'll be able to use all of Haml's tricks to write some really clean markup. You can use liquid filters easily by just rendering the liquid tags as shown below. Have fun! +**Important**: For Jekyll to invoke Haml on your file, it must have front-matter (the section contained between the `---`) at the top. If you don't have any front-matter, you need to include an empty one (see below for example), otherwise Jekyll might serve your Haml file as is. + ```haml --- title: Story Time @@ -36,6 +38,13 @@ permalink: page/ $(document).ready(function(){}); ``` +```haml +--- +--- +.title + %h1 This is a page without front-matter content +``` + ### Markdown blocks For clean content blocks, I find it helps to use Haml's `:markdown` filter if I can get away with it.