-
Notifications
You must be signed in to change notification settings - Fork 1
/
install.html
179 lines (167 loc) · 8.92 KB
/
install.html
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
171
172
173
174
175
176
177
178
179
<!doctype html>
<!-- https://github.com/paulirish/html5-boilerplate/blob/master/index.html -->
<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ -->
<!--[if lt IE 7 ]> <html lang="en" class="no-js ie6"> <![endif]-->
<!--[if IE 7 ]> <html lang="en" class="no-js ie7"> <![endif]-->
<!--[if IE 8 ]> <html lang="en" class="no-js ie8"> <![endif]-->
<!--[if (gte IE 9)|!(IE)]><!--> <html lang="en" class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<!-- Always force latest IE rendering engine (even in intranet) & Chrome Frame
Remove this if you use the .htaccess -->
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<!-- encoding must be specified within the first 512 bytes
www.whatwg.org/specs/web-apps/current-work/multipage/semantics.html#charset -->
<!-- meta element for compatibility mode needs to be before
all elements except title & meta
msdn.microsoft.com/en-us/library/cc288325(VS.85).aspx -->
<!-- Chrome Frame is only invoked if meta element for
compatibility mode is within the first 1K bytes
code.google.com/p/chromium/issues/detail?id=23003 -->
<title>Installation</title>
<meta name="description" content="Awesome documentation for hyde - a python static website generator
">
<meta name="author" content="Lakshmi Vyasarajan">
<!-- Mobile viewport optimized: j.mp/bplateviewport -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Place favicon.ico & apple-touch-icon.png
in the root of your domain and delete these references -->
<link rel="shortcut icon" href="/favicon.ico">
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
<script type="text/javascript" src="http://use.typekit.com/hyw1bsz.js"></script>
<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
<link rel="stylesheet" href="/media/css/site.css">
<link rel="stylesheet" href="/media/css/syntax.css">
<!-- All JavaScript at the bottom, except for Modernizr which
enables HTML5 elements & feature detects -->
<script src="/media/js/libs/modernizr-1.6.min.js"></script>
</head>
<body id="install">
<div id="container">
<div id="main" role="main">
<header class="banner clearfix">
<img src="/media/img/hyde-logo-128.png">
<h1>hyde</h1>
<h3>A static website generator</h3> </header>
<div class="doc">
<article>
<hgroup>
<h1 class="title">Installation</h1>
<h3 class="subtitle">PIPing hot hyde</h3>
</hgroup>
<p>Installing hyde is as simple as running the following command:
<div class="codebox"><figure class="code"><div class="highlight"><pre>pip install hyde<br /></pre></div><br /><figcaption>Bash</figcaption></figure></div></p>
<p>However, based on your choice and use of plugins you may need to install
additional packages. The requirements for each plugin is outlined in the
corresponding <a href="/plugins">plugin documentation</a>.</p>
<h2 id="dependencies">Dependencies</h2>
<p>While your mileage may vary, we consider the following to be essential for
generating a static website with hyde. These are a part of the requirements
file and the above command will download and install all of them as part
of hyde.</p>
<p>It is also recommended that you use <a href="http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/">virtualenv</a> to separate the hyde
environment from other python projects. Note that installing hyde using
pip would install all of the below. However, if you’d like finer grained
control over the packages, you can install these individually:</p>
<ol>
<li><code>argparse</code>: argparse is required if you are on python 2.6.</li>
<li><code>commando</code>: commando is a wrapper on top of argparse to give better syntax
and support for multi-command applications.</li>
<li><code>Jinja2</code>: While hyde will support many more template languages in the
future, currently, Jinja2 is wholly supported and recommended.</li>
<li><code>Markdown</code>: While there are plans to add support for other markups
(textile, restructured text, asciidoc etc..,), markdown is the one thats
currently completely supported.</li>
<li><code>Pyyaml</code>: Much of hyde’s <a href="/config">configuration</a> is done using yaml.</li>
<li><code>pygments</code>: For syntax coloring.</li>
<li><code>Typogrify</code>: Typogrify automatically fixes and enhances the typographical
accuracy of your content. While this is not a technical requirement for
hyde, it is absolutely essential to create good looking content.</li>
</ol>
<p>The following commands can be used to install the dependencies for hyde
individually:
<div class="codebox"><figure class="code"><div class="highlight"><pre>pip install argparse<br />pip install commando<br />pip install jinja2<br />pip install markdown<br />pip install pyyaml<br />pip install pygments<br />pip install smartypants<br />pip install -e git://github.com/hyde/typogrify#egg<span class="o">=</span>typogrify<br /></pre></div><br /><figcaption>Bash</figcaption></figure></div></p> </article>
<aside>
<ul class="toc">
<li><mark class="version">Version: 0.8</mark></li>
<li class="topic" id="topic1">
<ul class="links">
<li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/index.html">
Overview</a> </li>
</ul>
</li><li class="topic" id="topic2">
<h2 class=" active">Getting Started</h2> <ul class="links">
<li>
<a class="active" title="Awesome documentation for hyde - a python static website generator
"
href="/install.html">
Installation</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/commands.html">
Command Line</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/server.html">
Hyde web server</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/config.html">
Configuration</a> </li>
</ul>
</li><li class="topic" id="topic3">
<h2 class="">Templating Guide</h2> <ul class="links">
<li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/templates/index.html">
Creating layouts</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/templates/context.html">
Context Variables</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/templates/markrefer.html">
References</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/templates/text.html">
Text</a><li>
<a title="Awesome documentation for hyde - a python static website generator
"
href="/templates/traversing.html">
Traversing</a> </li>
</ul>
</li> </ul>
<nav class="prevnext">
<a
class="prev"
title="Overview"
href="/index.html">
←Previous
</a> <a
class="next"
title="Command Line"
href="/commands.html">
Next→
</a> <br class="clear">
</nav>
</aside>
</div>
<footer>
<p><a href="https://github.com/hyde/hyde">smelted with hyde</a> —
<a href="https://github.com/hyde/hyde.github.com/issues">spot <span class="amp">&</span> complain</a> —
<a href="https://github.com/hyde/docs">fork <span class="amp">&</span> fix</a></p></footer> </div>
<footer>
</footer>
</div> <!--! end of #container -->
<!-- Javascript at the bottom for fast page loading -->
<!-- Grab Google CDN's jQuery. fall back to local if necessary -->
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.js"></script>
<script>!window.jQuery && document.write(unescape('%3Cscript src="/media/js/libs/jquery-1.4.4.min.js"%3E%3C/script%3E'))</script>
</body>
</html>