Overview

Hyde starter kit_ by merlinrebrovic_ is a really nice way to get started with hyde.

Hyde layout for bootstrap_ by auzigog_ is also a good alternative if you like Twitter's bootstrap framework_.

You can also take a look at Hyde Powered Websites_ for inspiration and reference.

Currently hyde is only supported on python 2.7.x. Python 3.x support is in progress, thanks to jonafato_.

Hyde is not actively maintained.

Mailing List: hyde-dev_ on google groups. IRC: #hyde on freenode

Installation

To get the latest released version:

pip install hyde

For the current trunk:

pip install -e git://github.com/hyde/hyde.git#egg=hyde

Creating a new hyde site

The following command:

    hyde -s ~/test_site create

will create a new hyde site using the test layout.

Generating the hyde site

    cd ~/test_site
    hyde gen

Serving the website

    cd ~/test_site
    hyde serve
    open http://localhost:8080

Publishing the website

    cd ~/test_site
    hyde publish -p github

Hyde supports extensible publishers.

Github


The hyde documentation is published to github pages using this command with
the following configuration:

::

        publisher:
            github:
                type: hyde.ext.publishers.dvcs.Git
                path: ../hyde.github.com
                url: git@github.com:hyde/hyde.github.com.git

.. Note:: Currently, the initial path must have clone of the repository
          already in place for this command to work.

PyFS

Hyde also has a publisher that acts as a frontend to the awesome PyFS library_ (thanks to rfk_). Here are a few configuration options for some PyFS backends:

    publisher:
        zip:
            type: hyde.ext.publishers.pyfs.PyFS
            url: zip://~/deploy/hyde/docs.zip
        s3:
            type: hyde.ext.publishers.pyfs.PyFS
            url: s3://hyde/docs
        sftp:
            type: hyde.ext.publishers.pyfs.PyFS
            url: sftp:hydeuser:hydepassword@hydedocs.org

.. Note:: PyFS is not installed with hyde. In order to use the PyFS publisher, you need to install pyfs separately.

Any PyFS dependencies (Example: boto for S3 publishing) need to be installed separately as well.

    pip install fs
    pip install boto

To get additional help on PyFS backends, you can run the following command once PyFS is installed:

    fsls --listopeners

Examples

julien.danjou.info_
luffy.cx_
Cloudpanic_
Hyde Documentation Source_

A brief list of features

Evented Plugins: The Plugin hooks allow plugins to listen to events that occur during different times in the lifecycle and respond accordingly.
Metadata: Hyde now supports hierarchical metadata. You can specify and override variables at the site, node or the page level and access them in the templates.
Organization: The sorter, grouper and tagger plugins provide rich meta-data driven organizational capabilities to hyde sites.
Publishing: Hyde sites can be published to variety of targets including github pages, Amazon S3 & SFTP.

Links

Changelog_
Authors_

.. _hyde: https://github.com/lakshmivyas/hyde .. _Hyde documentation: http://hyde.github.com .. _Hyde Documentation Source: https://github.com/hyde/docs .. _Cloudpanic: https://github.com/tipiirai/cloudpanic .. _Authors: https://github.com/hyde/hyde/graphs/contributors .. _Changelog: https://github.com/hyde/hyde/blob/master/CHANGELOG.rst .. _Hyde starter kit: http://merlin.rebrovic.net/hyde-starter-kit/about.html .. _merlinrebrovic: https://github.com/merlinrebrovic .. _rfk: https://github.com/rfk .. _PyFS library: http://packages.python.org/fs/ .. _Hyde layout for bootstrap: https://github.com/auzigog/hyde-bootstrap .. _auzigog: https://github.com/auzigog .. _bootstrap framework: http://twitter.github.com/bootstrap/ .. _Hyde Powered Websites: https://github.com/hyde/hyde/wiki/Hyde-Powered .. _hyde-dev: https://groups.google.com/forum/#!forum/hyde-dev .. _julien.danjou.info: https://github.com/jd/julien.danjou.info .. _luffy.cx: https://github.com/vincentbernat/www.luffy.cx .. _jonafato: https://github.com/jonafato .. _llonchj: https://github.com/llonchj

Hyde

Install / Use

README