-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
217 lines (205 loc) · 11 KB
/
index.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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<!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>Overview</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="index">
<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">Overview</h1>
<h3 class="subtitle">hyde in a nutshell</h3>
</hgroup>
<p>Hyde is a static website generator written in python. While Hyde took
life as <a href="http://jekyllrb.com">awesome Jekyll</a>'s <a href="http://ringce.com/blog/2009/introducing_hyde">evil twin</a>, it has since been
completely consumed by <a href="http://python.org">the dark side</a> and has an
<a href="http://groups.google.com/group/hyde-dev/web/hyde-1-0">identity of its own</a>.</p>
<p>Hyde desires to fulfill the lofty goal of removing the
<a href="/static/#cons">pain points</a> involved in creating and maintaining
<a href="[static/#pros]]">static websites</a>.</p>
<h2 id="spotlight">Spotlight</h2>
<ul>
<li>Support for powerful template languages like <a href="http://jinja.pocoo.org/">Jinja2</a> complemented
with custom tags and filters.</li>
<li>Rich <a href="/template/#variables">object model</a> and
overridable hierarchical <a href="/plugins/metadata">metadata</a> thats available for use in templates.</li>
<li>Configurable <a href="/plugins/sorter">sorting, tagging and grouping</a> support.</li>
<li>Extensible <a href="/plugins">plugin architecture</a> with text preprocessing and <span class="caps">HTML</span>
postprocessing support for complex content transformations.</li>
<li>Instant preview using built-in <a href="/server">webserver</a> that regenerates
content if needed.</li>
</ul>
<h2 id="install">Install</h2>
<p>Hyde is available on <a href="http://pypi.python.org/pypi/hyde">pypi</a>.</p>
<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>You can find more detailed documentation in the
<a href="/install">installation section</a>.</p>
<h2 id="run">Run</h2>
<p>After installation is successful, creating <span class="amp">&</span> generating your website is
extremely simple.</p>
<p>To create a new hyde website:
<div class="codebox"><figure class="code"><div class="highlight"><pre>hyde -s /path/to/your/site create<br /></pre></div><br /><figcaption>Bash</figcaption></figure></div></p>
<p>To generate the website:
<div class="codebox"><figure class="code"><div class="highlight"><pre><span class="nb">cd</span> /path/to/your/site<br />hyde gen<br /></pre></div><br /><figcaption>Bash</figcaption></figure></div></p>
<p>The hyde web server is a simple bare-bones webserver based on the python
<a href="http://docs.python.org/library/simplehttpserver.html">Simple <span class="caps">HTTP</span> Request Handler</a>.</p>
<p>The following command starts the built in webserver:
<div class="codebox"><figure class="code"><div class="highlight"><pre>hyde serve<br /></pre></div><br /><figcaption>Bash</figcaption></figure></div></p>
<p>You can access your website now at <code>http://localhost:8080</code>.</p>
<p>The webserver regenerates the necessary files to serve your request. So, you
can make your changes and simply refresh your browser to view them.</p>
<p>For all the supported options, read the
<a href="/commands">command line documentation</a> or run <code>hyde -h</code>.</p>
<h2 id="your_first_hyde_website">Your first hyde website</h2>
<p>Hyde uses the <code>basic</code> layout to generate your website by default. When you
view your generated website, you will see the following dummy pages:</p>
<p><figure>
<a
title="The home page"
target="_hyde_basic"
href="http://emberapp.com/lakshmivyas/images/hyde-basic-home/sizes/o">
<img src="http://emberapp.com/lakshmivyas/images/hyde-basic-home/sizes/s.png"
alt="The home page">
</a><a
title="List of blog posts"
target="_hyde_basic"
href="http://emberapp.com/lakshmivyas/images/hyde-basic-list/sizes/o">
<img src="http://emberapp.com/lakshmivyas/images/hyde-basic-list/sizes/s.png"
alt="List of blog posts">
</a><a
title="A blog post"
target="_hyde_basic"
href="http://emberapp.com/lakshmivyas/images/hyde-basic-blog-post/sizes/o">
<img src="http://emberapp.com/lakshmivyas/images/hyde-basic-blog-post/sizes/s.png"
alt="A blog post">
</a><a
title="List of blogs posts with a specific tag"
target="_hyde_basic"
href="http://emberapp.com/lakshmivyas/images/hyde-basic-tag-list/sizes/o">
<img src="http://emberapp.com/lakshmivyas/images/hyde-basic-tag-list/sizes/s.png"
alt="List of blogs posts with a specific tag">
</a><figcaption>Hyde Basic Template - Screenshots</figcaption>
</figure></p>
<p>You can now continue to edit the content, layout and styles to customize it to
your needs. Please see the <a href="/templates">templating guide</a> to get more information.</p>
<h2 id="source">Source</h2>
<p>Hyde is <a href="https://github.com/hyde/hyde">socially coded</a>. Feel free to <a href="/contribute">fork</a>.</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 class="active" 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="">Getting Started</h2> <ul class="links">
<li>
<a 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="next"
title="Installation"
href="/install.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>