test/markups/README.1.html (view raw)
1<div><div float='left'>MUSTACHE(1)</div><h1 align=center>MUSTACHE</h1><div float='right'>MUSTACHE(1)</div></div>
2
3
4
5<a name="NAME"></a>
6<h2>NAME</h2>
7
8
9
10<p style="margin-left:11%; margin-top: 1em"><b>mustache</b>
11−− Mustache processor</p>
12
13<a name="SYNOPSIS"></a>
14<h2>SYNOPSIS</h2>
15
16
17<p style="margin-left:11%; margin-top: 1em"><b>cat data.yml
18template.mustache | mustache</b></p>
19
20<a name="DESCRIPTION"></a>
21<h2>DESCRIPTION</h2>
22
23
24<p style="margin-left:11%; margin-top: 1em">Mustache is a
25logic−less templating system for HTML, config files,
26anything.</p>
27
28<p style="margin-left:11%; margin-top: 1em">The
29<b>mustache</b> command processes a Mustache template
30preceded by YAML frontmatter from standard input and prints
31one or more documents to standard output.</p>
32
33<p style="margin-left:11%; margin-top: 1em">YAML
34frontmatter beings with <b>---</b> on a single line,
35followed by YAML, ending with another <b>---</b> on a single
36line, e.g.</p>
37
38<table width="100%" border=0 rules="none" frame="void"
39 cellspacing="0" cellpadding="0">
40<tr valign="top" align="left">
41<td width="17%"></td>
42<td width="5%">
43
44
45<p style="margin-top: 1em" valign="top"><b>---</b></p></td>
46<td width="78%">
47</td>
48</table>
49
50<p style="margin-left:17%;"><b>names: [ {name: chris},
51{name: mark}, {name: scott} ] <br>
52---</b></p>
53
54<p style="margin-left:11%; margin-top: 1em">If you are
55unfamiliar with YAML, it is a superset of JSON. Valid JSON
56should work fine.</p>
57
58<p style="margin-left:11%; margin-top: 1em">After the
59frontmatter should come any valid Mustache template. See
60mustache(5) for an overview of Mustache templates.</p>
61
62<p style="margin-left:11%; margin-top: 1em">For
63example:</p>
64
65<table width="100%" border=0 rules="none" frame="void"
66 cellspacing="0" cellpadding="0">
67<tr valign="top" align="left">
68<td width="17%"></td>
69<td width="15%">
70
71
72
73<p style="margin-top: 1em" valign="top"><b>{{#names}}</b></p> </td>
74<td width="68%">
75</td>
76</table>
77
78<p style="margin-left:17%;"><b>Hi {{name}}! <br>
79{{/names}}</b></p>
80
81<p style="margin-left:11%; margin-top: 1em">Now let’s
82combine them.</p>
83
84<table width="100%" border=0 rules="none" frame="void"
85 cellspacing="0" cellpadding="0">
86<tr valign="top" align="left">
87<td width="17%"></td>
88<td width="21%">
89
90
91<p style="margin-top: 1em" valign="top"><b>$ cat
92data.yml</b></p> </td>
93<td width="62%">
94</td>
95</table>
96
97<p style="margin-left:17%;"><b>--- <br>
98names: [ {name: chris}, {name: mark}, {name: scott} ] <br>
99--- <br>
100$ cat template.mustache <br>
101{{#names}} <br>
102Hi {{name}}! <br>
103{{/names}}</b></p>
104
105<p style="margin-left:17%; margin-top: 1em"><b>$ cat
106data.yml template.mustache | mustache <br>
107Hi chris! <br>
108Hi mark! <br>
109Hi scott!</b></p>
110
111<p style="margin-left:11%; margin-top: 1em">If you provide
112multiple YAML documents (as delimited by <b>---</b>), your
113template will be rendered multiple times. Like a mail
114merge.</p>
115
116<p style="margin-left:11%; margin-top: 1em">For
117example:</p>
118
119<table width="100%" border=0 rules="none" frame="void"
120 cellspacing="0" cellpadding="0">
121<tr valign="top" align="left">
122<td width="17%"></td>
123<td width="21%">
124
125
126<p style="margin-top: 1em" valign="top"><b>$ cat
127data.yml</b></p> </td>
128<td width="62%">
129</td>
130</table>
131
132<p style="margin-left:17%;"><b>--- <br>
133name: chris <br>
134--- <br>
135name: mark <br>
136--- <br>
137name: scott <br>
138--- <br>
139$ cat template.mustache <br>
140Hi {{name}}!</b></p>
141
142<p style="margin-left:17%; margin-top: 1em"><b>$ cat
143data.yml template.mustache | mustache <br>
144Hi chris! <br>
145Hi mark! <br>
146Hi scott!</b></p>
147
148<a name="INSTALLATION"></a>
149<h2>INSTALLATION</h2>
150
151
152<p style="margin-left:11%; margin-top: 1em">If you have
153RubyGems installed:</p>
154
155<table width="100%" border=0 rules="none" frame="void"
156 cellspacing="0" cellpadding="0">
157<tr valign="top" align="left">
158<td width="17%"></td>
159<td width="31%">
160
161
162<p style="margin-top: 1em" valign="top"><b>gem install
163mustache</b></p> </td>
164<td width="52%">
165</td>
166</table>
167
168<a name="COPYRIGHT"></a>
169<h2>COPYRIGHT</h2>
170
171
172<p style="margin-left:11%; margin-top: 1em">Mustache is
173Copyright (C) 2009 Chris Wanstrath</p>
174
175<p style="margin-left:11%; margin-top: 1em">Original
176CTemplate by Google</p>
177
178<a name="SEE ALSO"></a>
179<h2>SEE ALSO</h2>
180
181
182<p style="margin-left:11%; margin-top: 1em">mustache(5),
183mustache(7),
184gem(1),<i>http://defunkt.github.com/mustache/</i></p>