haml-coffee
Version:
Haml templates where you can write inline CoffeeScript.
123 lines (120 loc) • 3.24 kB
HTML
<html>
<head>
<title>Haml Coffee Documentation</title>
<link rel='stylesheet' href='../assets/codo.css' type='text/css'>
<script src='../assets/codo.js'></script>
</head>
<body>
<div id='header'>
<div id='menu'>
<a href='../class_index.html' title='Index'>Index</a>
»
<span class='title'>CoffeeMaker</span>
<nav>
<ul>
<li class='frames'>
(<a class='frames' href='../frames.html'>frames</a>)
</li>
<li class='noframes'>
(<a class='noframes' href='#'>no frames</a>)
</li>
</ul>
</nav>
<div id='search'>
<a id='class_list_link' href='../class_list.html'>Class List</a>
<a id='method_list_link' href='../method_list.html'>Method List</a>
<a id='file_list_link' href='../file_list.html'>File List</a>
</div>
</div>
<iframe id='search_frame'></iframe>
</div>
<div id='content'>
<h1>
Class:
CoffeeMaker
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/cli/coffee-maker.coffee</td>
</tr>
</table>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#compileFile-class'>
+ (void) <strong>compileFile</strong>(filename, compilerOptions = {}, namespace = null, templateName = null)
</a>
</span>
<span class='desc'>
Compiles a Haml-Coffee file to a JavaScript template.
</span>
</li>
</ul>
<h2>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='compileFile-class'>
+ (void) <strong>compileFile</strong>(filename, compilerOptions = {}, namespace = null, templateName = null)
</p>
<div class='docstring'>
<p>Compiles a Haml-Coffee file to a JavaScript template.
When the output template is omitted, it will be derived from the file name.
</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>filename</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>the Haml coffee file to compile</span>
</li>
<li>
<span class='name'>compilerOptions</span>
<span class='type'>
(<tt>Object</tt>)
</span>
—
<span class='desc'>the compiler options</span>
</li>
<li>
<span class='name'>namespace</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>the template namespace</span>
</li>
<li>
<span class='name'>templateName</span>
<span class='type'>
(<tt>String</tt>)
</span>
—
<span class='desc'>the name of the output template</span>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
Generated on
Sun Feb 26 2012 12:33:24 GMT+0100 (CET)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>codo</a>
v0.4.1
(Node.js v0.6.11).
✲
<a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
✲
<a href='https://mksoft.ch'>mksoft.ch</a>
</div>
</body>
</html>