=== title: Overview subtitle: hyde in a nutshell created: 2011-01-25 21:31:03 === §§ blurb Hyde is a static website generator written in python. While Hyde took life as [awesome Jekyll][Jekyll]'s [evil twin][], it has since been completely consumed by [the dark side][python] and has an [identity of its own][hydeid]. Hyde desires to fulfill the lofty goal of removing the [pain points][static cons] involved in creating and maintaining [static websites][static pros]. §§ /blurb ## Spotlight * Support for powerful template languages like [Jinja2][] complemented with custom tags and filters. * Rich [object model][] and overridable hierarchical [metadata][] thats available for use in templates. * Configurable [sorting, filtering and grouping][sorter] support. * Extensible [plugin architecture][plugins] with Text preprocessing and html postprocessing support for complex content transformations. * Instant preview using built-in [webserver][server] that regenerates content if needed. ## Install There will be a package soon on pypi, but this works for now: ~~~sh~~~ pip install -e https://github.com/hyde/hyde#egg=hyde ~~~~~~~~ You can find more detailed documentation in the [installation section][install]. ## Run After installation is successful, creating & generating your website is extremely simple. To create a new hyde website: ~~~sh~~~ hyde -s /path/to/your site create ~~~~~~~~ To generate the website: ~~~sh~~~ cd /path/to/your/site hyde gen ~~~~~~~~ To run the built in webserver that autogenerates if needed: ~~~sh~~~ hyde serve ~~~~~~~~ You can access the website now at `http://localhost:8080` For all the supported options, read the [command line documentation][commandline] or run `hyde -h`. ## Source Hyde is [socially coded][hyde]. Feel free to [fork][forking]. ## Project Roadmap 1. Support for Django and Mako * Template implementation * Default layouts 2. Support for other markup languages * restructured text * textile * asciidoc 3. Text Compression * Slimmer * pre-gzipping * uglifyjs 4. Image Manipulation * Optipng Compression * Thumbnail generation * Photo Data Extraction 5. Feed / Listing generation 6. Translation [hydeid]: http://groups.google.com/group/hyde-dev/web/hyde-1-0 [Jekyll]: http://jekyllrb.com [evil twin]: http://ringce.com/blog/2009/introducing_hyde [Jinja2]: http://jinja.pocoo.org/ [object model]: [[template/#variables]] [hyde]: https://github.com/hyde/hyde [install]: [[install]] [metadata]: [[plugins/metadata]] [plugins]: [[plugins]] [python]: http://python.org [server]: [[server]] [sorter]: [[plugins/sorter]] [static cons]: [[static/#cons]] [static pros]: [static/#pros]] [forking]: [[contribute]] [commandline]: [[commandline]]