summaryrefslogtreecommitdiff
path: root/website/manual/index.html
blob: 5bedd0ae7ddb7ae2e0afd149442e1094be4c2a5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2015 David Thompson


Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Haunt Reference Manual: Top</title>

<meta name="description" content="Haunt Reference Manual: Top">
<meta name="keywords" content="Haunt Reference Manual: Top">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="../dir/index.html" rel="up" title="(dir)">
<link href="Introduction.html#Introduction" rel="next" title="Introduction">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<h1 class="settitle" align="center">Haunt Reference Manual</h1>





<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>

<div class="contents">

<ul class="no-bullet">
  <li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li>
  <li><a name="toc-Installation-1" href="Installation.html#Installation">2 Installation</a>
  <ul class="no-bullet">
    <li><a name="toc-Downloading-1" href="Downloading.html#Downloading">2.1 Downloading</a></li>
    <li><a name="toc-Requirements-1" href="Requirements.html#Requirements">2.2 Requirements</a></li>
    <li><a name="toc-Building-1" href="Building.html#Building">2.3 Building</a></li>
  </ul></li>
  <li><a name="toc-Tutorial-1" href="Tutorial.html#Tutorial">3 Tutorial</a></li>
  <li><a name="toc-Command_002dline-Interface-1" href="Command_002dline-Interface.html#Command_002dline-Interface">4 Command-line Interface</a>
  <ul class="no-bullet">
    <li><a name="toc-Invoking-haunt-build-1" href="Invoking-haunt-build.html#Invoking-haunt-build">4.1 Invoking <code>haunt build</code></a></li>
    <li><a name="toc-Invoking-haunt-serve-1" href="Invoking-haunt-serve.html#Invoking-haunt-serve">4.2 Invoking <code>haunt serve</code></a></li>
  </ul></li>
  <li><a name="toc-Programming-Interface-1" href="Programming-Interface.html#Programming-Interface">5 Programming Interface</a>
  <ul class="no-bullet">
    <li><a name="toc-Sites-1" href="Sites.html#Sites">5.1 Sites</a></li>
    <li><a name="toc-Posts-1" href="Posts.html#Posts">5.2 Posts</a></li>
    <li><a name="toc-Readers-1" href="Readers.html#Readers">5.3 Readers</a>
    <ul class="no-bullet">
      <li><a name="toc-Reader-1" href="Reader.html#Reader">5.3.1 Reader</a></li>
      <li><a name="toc-Texinfo-1" href="Texinfo.html#Texinfo">5.3.2 Texinfo</a></li>
      <li><a name="toc-Skribe-1" href="Skribe.html#Skribe">5.3.3 Skribe</a></li>
      <li><a name="toc-CommonMark-1" href="CommonMark.html#CommonMark">5.3.4 CommonMark</a></li>
    </ul></li>
    <li><a name="toc-Pages-1" href="Pages.html#Pages">5.4 Pages</a></li>
    <li><a name="toc-Assets-1" href="Assets.html#Assets">5.5 Assets</a></li>
    <li><a name="toc-Builders-1" href="Builders.html#Builders">5.6 Builders</a>
    <ul class="no-bullet">
      <li><a name="toc-Static-Assets-1" href="Static-Assets.html#Static-Assets">5.6.1 Static Assets</a></li>
      <li><a name="toc-Blog-1" href="Blog.html#Blog">5.6.2 Blog</a></li>
      <li><a name="toc-Atom-1" href="Atom.html#Atom">5.6.3 Atom</a></li>
    </ul></li>
  </ul></li>
  <li><a name="toc-Contributing-1" href="Contributing.html#Contributing">6 Contributing</a></li>
  <li><a name="toc-GNU-Free-Documentation-License-1" href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a></li>
  <li><a name="toc-Concept-Index-1" href="Concept-Index.html#Concept-Index">Concept Index</a></li>
  <li><a name="toc-Programming-Index-1" href="Programming-Index.html#Programming-Index">Programming Index</a></li>
</ul>
</div>


<a name="Top"></a>
<div class="header">
<p>
Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Haunt"></a>
<h1 class="top">Haunt</h1>

<p>This document describes Haunt version 0.2.1, an extensible,
functional static site generator.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">About Haunt.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installation.html#Installation" accesskey="2">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Installing Haunt.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Tutorial.html#Tutorial" accesskey="3">Tutorial</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How to get started quickly.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Command_002dline-Interface.html#Command_002dline-Interface" accesskey="4">Command-line Interface</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Using Haunt from the command-line.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Programming-Interface.html#Programming-Interface" accesskey="5">Programming Interface</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Using the Haunt API in Scheme.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Contributing.html#Contributing" accesskey="6">Contributing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">How to contribute to Haunt.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License" accesskey="7">GNU Free Documentation License</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">The license of this manual.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Concept-Index.html#Concept-Index" accesskey="8">Concept Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Concepts.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Programming-Index.html#Programming-Index" accesskey="9">Programming Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Data types, procedures, syntax, and variables.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> &mdash; The Detailed Node Listing &mdash;

Installation

</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Downloading.html#Downloading">Downloading</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Downloading the source code.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Requirements.html#Requirements">Requirements</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Software needed to build and run Haunt.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Building.html#Building">Building</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">Building from source code.
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">

</pre></th></tr></table>

<hr>
<div class="header">
<p>
Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>