jmg
/
hyde


			
				
					
						
						
							
							<!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">
  
    <!-- 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="overview">
    <div id="container">
            <div id="main" role="main">
          <header class="banner clearfix">
          <img src="/media/img/hyde-logo-128.png">
            <h1>hyde 1.0</h1>
            <h3>static hotness</h3>          </header>
          <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>&apos;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.html/#cons">pain points</a> involved in creating and maintaining
<a href="[static.html/#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&nbsp;filters.</li>
<li>Rich <a href="/template.html/#variables">object model</a> and
    overridable hierarchical <a href="/plugins/metadata.html">metadata</a> thats available for use in&nbsp;templates.</li>
<li>Configurable <a href="/plugins/sorter.html">sorting, filtering and grouping</a>&nbsp;support.</li>
<li>Extensible <a href="/plugins.html">plugin architecture</a> with Text preprocessing and html
    postprocessing support for complex content&nbsp;transformations.</li>
<li>Instant preview using built-in <a href="/server.html">webserver</a> that regenerates content
    if&nbsp;needed.</li>
</ul>
<h2 id="install">Install</h2>
<p>There will be a package soon on pypi, but this works for&nbsp;now:</p>
<div class="code"><div class="highlight"><pre>pip install -e https://github.com/hydepy/hyde#egg<span class="o">=</span>hyde<br /></pre></div><br /></div>

<p>You can find more detailed documentation in the <a href="/install.html">installation section</a>.</p>
<h2 id="run">Run</h2>
<p>After installation is successful, creating <span class="amp">&amp;</span> generating your website is
extremely&nbsp;simple.</p>
<p>To create a new hyde&nbsp;website:</p>
<div class="code"><div class="highlight"><pre>hyde -s /path/to/your site create<br /></pre></div><br /></div>

<p>To generate the&nbsp;website:</p>
<div class="code"><div class="highlight"><pre><span class="nb">cd</span> /path/to/your/site<br />hyde gen<br /></pre></div><br /></div>

<p>To run the built in webserver that autogenerates if&nbsp;needed:</p>
<div class="code"><div class="highlight"><pre>hyde serve<br /></pre></div><br /></div>

<p>You can access the website now at <code>http://localhost:8080</code></p>
<p>For all the supported options, read <a href="/commandline.html">command line documentation</a>
or run <code>hyde --h</code>.</p>
<h2 id="source">Source</h2>
<p>Hyde is <a href="https://github.com/hydepy/hyde">socially coded</a>. Feel free to <a href="/contribute.html">fork</a>.</p>
<h2 id="project_roadmap">Project&nbsp;Roadmap</h2>
<ol>
<li>Support for Django and Mako<ul>
<li>Template&nbsp;implementation</li>
<li>Default&nbsp;layouts</li>
</ul>
</li>
<li>Support for other markup languages<ul>
<li>restructured&nbsp;text</li>
<li>textile</li>
<li>asciidoc</li>
</ul>
</li>
<li>Text Compression<ul>
<li>Slimmer</li>
<li>pre-gzipping</li>
<li>uglifyjs</li>
</ul>
</li>
<li>Image Manipulation<ul>
<li>Optipng&nbsp;Compression</li>
<li>Thumbnail&nbsp;generation</li>
<li>Photo Data&nbsp;Extraction</li>
</ul>
</li>
<li>Feed / Listing&nbsp;generation</li>
<li>Translation</li>
</ol>
<p></article>
<aside>
</aside></p>      </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>