Some paragraph.
\n baz # this is a comment\n```\n\nThat template invoked with: `Hamlet(template, {foo:'f'})`. generates:\n\n``` html\nbaz
\n```\n\nThe library currently does not try to pretty print the resulting html, although it wouldn't be hard to do.\nNote the interpolation `#{var}}`. You can use other interpolation styles by changing the RegExp Hamlet.templateSettings.interpolate.\nYou can put any javascript you would like in the interpolation.\n\n## Good error messages\n\nUnlike Jade and many other templating options, Hamlet will tell you the line on which a javascript interpolation error occurred in your template. This does make it less powerful: read the next section.\n\nNote that Hamlet will pretty much parse about anything and spit it out as HTML so there aren't parsing syntax errors to deal with. In practice there are very few syntax issues because you already know hamlet: it is just HTML!.\n\n## Important: hamlet.js does not have a construct for conditional html (an if statement)\n\nThink of hamlet.js as your HTML pre-processor, but don't use it by itself to server 100% of your templating needs. hamlet.js works well when paired with something like AngularJS.\n\nGood use cases for hamlet.js\n* server-side (nodejs) usage: a template language for client-heavy apps. hamlet.js is used to stick a few values in server side, but AngularJS is used for most actual logic client-side.\n* client-side usage: client heavy apps that use hamlet.js just as an html pre-processor. A client-side AngularJS template can be written more concisely and safely with hamlet.js. It is first expanded through hamlet.js\n* client-side usage: client light applications that just want to stick a few values into their client-side html, but don't need template logic.\n\nBad use cases\n* server-side (nodejs) usage: template langauge where all template logic is performed on the server\n* client-side usage: a client-heavy app where all logic is encoded in hamlet.js\n\n\n### interpolation\n\nhamlet.js consists of the core hamlet language interspersed with javascript evaluation via `#{js}`.\nThe only thing you can place in the javascript evaluation is something that produces a String.\nThere is no way to have an `if` that may include some html if true.\n\nhamlet.js is designed for client-heavy apps that are using something like AngularJs on the client-side.\n`#{}` is for simple server-side templating, and an angular user can still use `{{}}` for the client-side (although ng-bind is often a better choice)\n\nOne benefit of the limited js evaluation is that hamlet can recover very good error messages when used on the server side (by evaluating each line of the template one-by-one). Having conditionals (as jade does by default for example) ruins error message reporting because the entire template must be evaluated at once.\n\n## Overview\n\nIt is just HTML! But redundancies are taken away\n\n* quoting attributes is not required unless they have spaces\n* Indentation is used to automatically close tags.\n\nThis loosely follows the original Haskell [Hamlet](http://www.yesodweb.com/book/templates) template language that I helped design. This implementation is simpler because it is invoked at runtime, just does a simple javascript eval, and has no concept of type insertion - this includes no html escaping. There is a [fork of this library](https://github.com/ajnsit/hamlet.js) that uses Haskell Hamlet style interpolation.\n\n## Usage\n\nThis uses the same style and code as the template function from underscore.js\n\n``` js\nrendered_html = Hamlet(template, object)\n```\n\nor\n\n``` js\npre_compiled_template = Hamlet(template)\nrendered_html = pre_compiled_template(object)\n```\n\nOr you can avoid all variable assertion and just expand hamlet with:\n\n``` js\nHamlet.toHtml('') // \"
\"\n```\n\n### nodejs\n\nvar hamlet = require('hamlet').hamlet\n\n``` js\nhamlet('') // \"
\"\n```\n\nThere is also a command line program `bin/hamlet.js`. It is not listed in package.json due to some weird install issues.\nSimilarly, the dependencies for that program are listed in the devDependencies.\n\n### Meteor\n\nThere is an [atmosphere package](https://github.com/maxcan/meteor-hamlet-handlebars).\n\n### Express\n\nIt should work with the '.hamlet' extension.\n\n## Layouts\n\nThis uses the filesystem so it only works for nodejs.\nJust add `layout path/to/layout` at the very top of your template.\nIn your layout file, use the special content variable `#{content}` to include the inner template content.\n\nSince Hamlet is designed for client-heavy usage there are no plans to support partials directly.\n\nYou can of course manually create layouts or partials by first rendering an inner template and setting that as a local variable in the outer template.\n\n## class/id shortcuts\n\nThe CSS-based shortcuts are originally taken from the HAML markup language.\nA '#' indicates an id, and a '.' indicates a class. You can add as many classes this way as you like.\n\n## Comments\n\nComments begin with a '#' character.\nWhen the template is compiled they are removed, not converted to html comments.\nThere is no support for html comments.\n\n## White space\n\nUsing indentation does have some consequences with respect to white space. This library is designed to just do the right thing most of the time. This is a slightly different design from the original Haskell implementation of Hamlet.\n\nA closing tag is placed immediately after the tag contents. If you want to have a space before a closing tag, use a comment sign `#` on the line to indicate where the end of the line is.\n\n``` html\nspaces # 2 spaces are included\n```\n\n``` html\nspaces \n```\n\nWhite space is automatically added *after* tags with inner text. If you have multiple lines of inner text without tags (not a common use case) they will also get a space added. If you do not want white space, you point it out with a `>` character, that you could think of as the end of the last tag, although you can still use it when separating content without tags onto different lines. You can also use a `>` if you want more than one space.\n\n``` html\n\n no space\n >none here either.\n > Two spaces after a period is bad, just use one!\n```\n\n``` html\n
no spacenone here either. Two spaces after a period is bad, just use one!
\n```\n\n## Closing bracket\n\ncurrently the '>' character is optional if there is no inner text on the same line. In the future this will be changed to be required so that tag attributes can span multiple lines.\n\n## Limitations\n\nHamlet just uses a simple eval interpolation.\nThis works well for me on an AngularJS project where AngularJS is actually doing the templating.\nYou might be able to use Hamlet to pre-process for another templating system.\n\n# Development \n\nRequires Coffeescript, although if you are only comfortable changing js I can easily port it to the Coffeescript file.\n\n## Testing\n\nThe test suite is pretty good now. I create a regression test for every issue I notice.\n\n npm test\n\nYou can run the tests in a browser by opening test/test.html and looking at the console.\n\nTest cases can be ported from the [Haskell Hamlet test suite](http://github.com/yesodweb/hamlet/hamlet/test/main.hs)\n\n\n## Converting from jade\n\nIf there are no variables interpreted in your jade, you can compile it down to html\n\n > jade.compile('test(attr=\"val\") text', {debug:false, compileDebug:false, pretty:true, client:true})()\n '\\nwtf'\n\nTODO: If there are variables, is there a way to set every variable value to `#{variable}` ?\n\n## Converting from html\n\nOne of the great things about Hamlet is that for a small amount of HTML, you can just delete the closing tags.\n\nThere is a Haskell tool `html2hamlet` (install Haskell, then cabal install html2hamlet)\n\n ❯ echo '\\ntext' | ./cabal-dev/bin/html2hamlet\n !!!\n \n text\n\n## Thanks\n\nI wrote the parser code, but the template insertion is stolen from [micro-template](https://github.com/cho45/micro-template.js) and express integration from jade.\n","maintainers":[{"name":"gregweber","email":"greg@gregweber.info"}],"time":{"modified":"2022-06-18T18:48:49.698Z","created":"2013-07-21T04:25:31.429Z","0.0.0":"2013-07-21T04:25:33.292Z","0.1.0":"2013-07-21T17:22:32.389Z","0.1.1":"2013-07-21T17:46:16.774Z","0.1.2":"2013-07-21T18:08:26.514Z","0.1.3":"2013-07-21T18:44:42.336Z","0.2.0":"2013-07-22T16:45:35.950Z","0.2.1":"2013-07-30T18:04:02.223Z","0.3.0":"2013-07-30T18:10:05.909Z","0.3.1":"2014-06-04T18:39:53.719Z","0.3.2":"2014-06-04T20:12:22.181Z","0.3.3":"2014-06-04T20:26:26.660Z"},"author":{"name":"Greg Weber","email":"greg@gregweber.info"},"repository":{"type":"git","url":"git://github.com/gregwebs/hamlet.js"},"homepage":"https://github.com/gregwebs/hamlet.js","bugs":{"url":"https://github.com/gregwebs/hamlet.js/issues"},"readmeFilename":"README.md"}