Skip to content

Readme: Add empty front-matter caveat #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Readme: Add empty front-matter caveat #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down