From 3f239914972009c53a9022d3644d81cc3aa83a81 Mon Sep 17 00:00:00 2001 From: Lakshmi Vyasarajan Date: Thu, 27 Jan 2011 12:03:02 +0530 Subject: [PATCH] Added installation and commandline docs --- docs/commandline.html | 197 ++++++++++++++++++ docs/install.html | 103 +++++++++ docs/installation.html | 103 +++++++++ docs/media/css/site.css | 77 +++++-- docs/overview.html | 45 ++-- hyde/ext/plugins/syntext.py | 2 +- hyde/layouts/doc/content/commandline.html | 173 +++++++++++++++ hyde/layouts/doc/content/install.html | 54 +++++ .../doc/content/media/css/inc/colors.less | 2 +- .../doc/content/media/css/inc/layout.less | 2 +- .../doc/content/media/css/inc/text.less | 16 ++ hyde/layouts/doc/content/media/css/site.less | 36 +++- hyde/layouts/doc/content/overview.html | 65 ++++-- hyde/layouts/doc/layout/doc.j2 | 4 + hyde/layouts/doc/layout/root.j2 | 2 +- 15 files changed, 815 insertions(+), 66 deletions(-) create mode 100644 docs/commandline.html create mode 100644 docs/install.html create mode 100644 docs/installation.html create mode 100644 hyde/layouts/doc/content/commandline.html create mode 100644 hyde/layouts/doc/content/install.html diff --git a/docs/commandline.html b/docs/commandline.html new file mode 100644 index 0000000..e343985 --- /dev/null +++ b/docs/commandline.html @@ -0,0 +1,197 @@ + + + + + + + + + + + + + + + + + + + Command Line + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+

Command Line

+

working with hyde

+
+

The hyde command line supports three subcommands:

+
    +
  1. create - Initializes a new site at a given path
    2. +
  2. gen - Generates the website to a configured deploy folder
    3. +
  3. serve - Starts a local http server that regenerates based on the requested file
    4. +
+

The create command

+

Creates a new hyde website.

+
hyde create
 
hyde [-s </site/path>] [-v] create [-l <layout>] [-f] [-h]

+ +
    +
  • +

    -s SITEPATH, --sitepath SITEPATH

    +

    Where the site must be created. If this path is not empty then the -f +option must be specified to overwrite the site.

    +

    Optional - defaults to current working directory.

    +
    • +
  • +

    -f, --force

    +

    Specifying this option will overwrite files and folders at the given +site path.

    +

    Optional - If the target directory is not empty, hyde will throw an +exception unless this is specified.

    +
    • +
  • +

    -l LAYOUT, --layout LAYOUT

    +

    The name of the layout to use for creating the initial site. Hyde currently +has three layouts: basic, test and doc.

    +

    While basic and test are really barebones, doc is the one that generates +this documentation and is completely usable. Hyde will get more layouts +as over time.

    +

    Hyde tries to locate the specified layout in the following folders:

    +
      +
    1. In layouts folder under the path specified by the HYDE_DATA + environment variable
      2. +
    2. In layouts folder under hyde
      3. +
    +

    Optional - defaults to basic

    +
    • +
  • +

    -v, --verbose

    +

    Logs detailed messages to the console.

    +

    Optional - shows only essential messages if this option is omitted.

    +
    • +
  • +

    -h

    +

    Displays the help text for the create command.

    +
    • +
+

Assuming the HYDE_DATA environment variable is empty and the folder +~/test is empty, the following command will create a new hyde site +at ~/test with the contents of layouts/doc folder:

+
hyde -s ~/test create -l doc

+ +

The generate command

+

Generates the given website.

+
hyde gen
 
hyde [-s </site/path>] [-v] gen [-d </deploy/path>] [-c <config/path>] [-h]

+ +
    +
  • +

    -s SITEPATH, --sitepath SITEPATH

    +

    The path to the site to be generated.

    +

    Optional - defaults to current working directory.

    +
    • +
  • +

    -d DEPLOY_PATH, --deploy-path DEPLOY_PATH

    +

    Location where the site should be generated. This option overrides any +setting specified in the hyde [configuration][]. The path is assumed to +be relative to the site path unless a preceding path separator is found.

    +

    Optional - Uses what is specified in the config file. The default option +in the configuration file is: deploy folder under the current site path.

    +
    • +
  • +

    -c CONFIG, --config-path CONFIG

    +

    This is used for specifying an alternate configuration file to use for +generating the site. This is useful if you have two different configurations +for you production versus development websites.

    +

    The path is assumed to be relative to the site path unless a preceding path +separator is found.

    +

    Optional - defaults to site.yaml

    +
    • +
  • +

    -v, --verbose

    +

    Logs detailed messages to the console.

    +

    Optional - shows only essential messages if this option is omitted.

    +
    • +
  • +

    -h

    +

    Displays the help text for the gen command.

    +
    • +
+

The following command will use production.yaml as the configuration file and +generate the website at ~/test to ~/production_site directory.

+
cd ~/test
hyde gen -c production.yaml -d ~/production_site

+ +

The serve command

+

Starts the built in web server that also regenerates based on the request if there are changes.

+
hyde serve
 
hyde [-s </site/path>] [-v] gen [-d </deploy/path>] [-c <config/path>] [-h]

+ +
    +
  • -s SITEPATH, --sitepath SITEPATH + -d DEPLOY_PATH, --deploy-path DEPLOY_PATH + -c CONFIG, --config-path CONFIG
    • +
+

Since the serve command auto generates if there is a need, it needs the same + parameters as the gen command. The above parameters serve the same purpose here + as in the gen command.

+
    +
  • -a ADDRESS, --address ADDRESS
    • +
+

The address to serve the website.

+

Optional - defaults to localhost

+
    +
  • -p PORT, --port
    • +
+

The port to serve the website.

+

Optional - default to 8080

+
    +
  • -h
    • +
+

Displays the help text for the serve command.

+

The following command will serve the website at http://localhost:8181

+
cd ~/test
hyde serve -p 8181

+ +

+

+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/docs/install.html b/docs/install.html new file mode 100644 index 0000000..a608e68 --- /dev/null +++ b/docs/install.html @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + + + + + Installation + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+

Installation

+

PIPing hot hyde

+
+

Installing hyde is as simple as running the following command:

+
pip install -e https://github.com/hydepy/hyde#egg=hyde

+ +

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 plugin documentation.

+

Essential Requirements

+

While your mileage may vary, I 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 them as part of hyde.

+

It is also recommended that you use virtualenv 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:

+
    +
  1. argparse: argparse is required if you are on python 2.6.
    2. +
  2. commando: commando is a wrapper on top of argparse to give better syntax and + support for multi-command applications.
    3. +
  3. Jinja2: While hyde will support many more template languages in the future, + currently, Jinja2 is wholly supported and recommended.
    4. +
  4. Markdown: While there are plans to add support for other markups (textile, + restructured text, asciidoc etc..,), markdown is the one thats currently + completely supported.
    5. +
  5. Pyyaml: Much of hyde’s [configuration] is done using yaml.
    6. +
  6. Typogrify: 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.
    7. +
+
pip install argparse
pip install commando
pip install jinja2
pip install markdown
pip install pyyaml
pip install -e https://github.com/hydepy/typogrify#egg=typogrify

+ +

+

+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/docs/installation.html b/docs/installation.html new file mode 100644 index 0000000..6605d24 --- /dev/null +++ b/docs/installation.html @@ -0,0 +1,103 @@ + + + + + + + + + + + + + + + + + + + Installation + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+

Installation

+

PIPing hot hyde

+
+

Installing hyde is as simple as running the following command:

+
pip install -e https://github.com/hydepy/hyde#egg=hyde

+ +

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 plugin documentation.

+

Essential Requirements

+

While your mileage may vary, I 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 them as part of hyde.

+

It is also recommended that you use virtualenv 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:

+
    +
  1. argparse: argparse is required if you are on python 2.6.
    2. +
  2. commando: commando is a wrapper on top of argparse to give better syntax and + support for multi-command applications.
    3. +
  3. Jinja2: While hyde will support many more template languages in the future, + currently, Jinja2 is wholly supported and recommended.
    4. +
  4. Markdown: While there are plans to add support for other markups (textile, + restructured text, asciidoc etc..,), markdown is the one thats currently + completely supported.
    5. +
  5. Pyyaml: Much of hyde’s [configuration] is done using yaml.
    6. +
  6. Typogrify: 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.
    7. +
+
pip install argparse
pip install commando
pip install jinja2
pip install markdown
pip install pyyaml
pip install -e https://github.com/hydepy/typogrify#egg=typogrify

+ +

+

+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/docs/media/css/site.css b/docs/media/css/site.css index 89ea440..4578bee 100644 --- a/docs/media/css/site.css +++ b/docs/media/css/site.css @@ -296,17 +296,17 @@ button { a { color: #497c55; text-decoration: none; - text-shadow: 0px 1px 0px #ededed; + text-shadow: 0px 1px 0px #fefdfd; } a:hover { color: #cd3b16; text-decoration: underline; - text-shadow: 0px 1px -1px #ededed; + text-shadow: 0px 1px -1px #fefdfd; } body { font-family: "ff-meta-web-pro-1", "ff-meta-web-pro-2", Helvetica, Arial, sans-serif; color: #132016; - background-color: #ededed; + background-color: #fefdfd; } .subheading { font-family: "anivers-1", "anivers-2", Helvetica, Arial, sans-serif; @@ -320,13 +320,13 @@ body { #container { width: 972px; margin: 0 auto 96px; - background-color: #ededed; + background-color: #fefdfd; } #main { margin: 12px; } article { - width: 600.7416563658837px; + width: 612px; } h1, h2, @@ -349,14 +349,29 @@ li ul, li ol { padding-bottom: 0; } .heading { - color: #c5c5c5; - text-shadow: -1px -1px 0px #939393, 1px 1px 0px #ffffff; + color: #d6d5d5; + text-shadow: -1px -1px 0px #a4a3a3, 1px 1px 0px #ffffff; } body { font-size: 20px; line-height: 24px; font-weight: normal; } +h1, +h2, +h3, +h4, +h5, +h6 { + font-family: "anivers-1", "anivers-2", Helvetica, Arial, sans-serif; +} +code, .highlight pre { + font-family: menlo, monaco, courier; +} +code { + color: rgba(0, 0, 0, 0.5); + font-size: 80%; +} .amp { font-family: Baskerville, Palatino, "Book Antiqua", serif; line-height: 75%; @@ -369,12 +384,12 @@ body { Also: hot pink. */ ::-moz-selection { background: #497c55; - color: #ededed; + color: #fefdfd; text-shadow: none; } ::selection { background: #497c55; - color: #ededed; + color: #fefdfd; text-shadow: none; } /* j.mp/webkit-tap-highlight-color */ @@ -387,7 +402,7 @@ a:link { .button:visited { background: #497c55; padding: 5px 10px 6px; - color: #ededed; + color: #fefdfd; text-decoration: none; -webkit-border-radius: 5px; -moz-border-radius: 5px; @@ -430,9 +445,9 @@ a:link { padding: 0 0 24px 0; } h2 { - font-size: 36px; + font-size: 24px; color: #453f19; - line-height: 48px; + line-height: 24px; } header.banner { width: 100%; @@ -445,20 +460,26 @@ header.banner img { float: left; } header.banner h1 { - color: #c5c5c5; - text-shadow: -1px -1px 0px #939393, 1px 1px 0px #ffffff; + color: #d6d5d5; + text-shadow: -1px -1px 0px #a4a3a3, 1px 1px 0px #ffffff; float: left; - margin-left: 48px; + margin-left: 46px; font-size: 96px; - line-height: 144px; + line-height: 152px; margin-bottom: 0; } header.banner h3 { - color: #453f19; + font-family: "anivers-1", "anivers-2", Helvetica, Arial, sans-serif; + font-size: 24px; + font-weight: normal; + color: #010202; + color: rgba(0, 0, 0, 0.5); position: absolute; - bottom: 14px; - left: 284px; + bottom: 12px; + font-size: 24px; + left: 266px; margin: 0; + text-shadow: -1px -1px 0px #a4a3a3, 1px 1px 0px #ffffff; } article { padding: 48px; @@ -467,12 +488,24 @@ article { -o-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5); box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5); } +article h1.title { + color: #497c55; + font-size: 36px; + margin-bottom: 6px; +} +article h3.subtitle { + color: #453f19; + font-size: 18px; + font-weight: normal; + padding-left: 6px; + border-bottom: 1px solid rgba(0, 0, 0, 0.1); + margin-bottom: 21px; +} .highlight pre { - font-size: 12px; - font-family: menlo, monaco, courier; + font-size: 11px; -moz-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5); -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5); -o-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5); box-shadow: 0 1px 3px rgba(0, 0, 0, 0.5); - padding: 12px; + padding: 18px 12px; } diff --git a/docs/overview.html b/docs/overview.html index 9334c75..70b2f66 100644 --- a/docs/overview.html +++ b/docs/overview.html @@ -49,34 +49,53 @@
+
+

Overview

+

hyde in a nutshell

+

Hyde is a static website generator written in python. While Hyde took -life as awesome Jekyll‘s evil twin, it has since been -completely consumed by the dark side to have an identity of its own.

+life as awesome Jekyll's evil twin, it has since been +completely consumed by the dark side and has an identity of its own.

Hyde desires to fulfill the lofty goal of removing the -pain points involved in creating and maintaining -static websites.

+pain points involved in creating and maintaining +static websites.

Spotlight

-

Source

-

Hyde is socially coded. Feel free to fork.

Install

There will be a package soon on pypi, but this works for now:

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

-

You can find more detailed documentation in the installation section.

+

You can find more detailed documentation in the installation section.

+

Run

+

After installation is successful, creating & generating your website is +extremely simple.

+

To create a new hyde website:

+
hyde -s /path/to/your site create

+ +

To generate the website:

+
cd /path/to/your/site
hyde gen

+ +

To run the built in webserver that autogenerates if needed:

+
hyde serve

+ +

You can access the website now at http://localhost:8080

+

For all the supported options, read command line documentation +or run hyde --h.

+

Source

+

Hyde is socially coded. Feel free to fork.

Project Roadmap

  1. Support for Django and Mako
      diff --git a/hyde/ext/plugins/syntext.py b/hyde/ext/plugins/syntext.py index f4c3c0a..c9598e8 100644 --- a/hyde/ext/plugins/syntext.py +++ b/hyde/ext/plugins/syntext.py @@ -24,7 +24,7 @@ class SyntextPlugin(TextyPlugin): """ The default pattern for block open text. """ - return '^~~~+\s*([A-Za-z0-9_\-\.]+)\s*~*\s*$' + return '^\s*~~~+\s*([A-Za-z0-9_\-\.]+)\s*~*\s*$' @property def default_close_pattern(self): diff --git a/hyde/layouts/doc/content/commandline.html b/hyde/layouts/doc/content/commandline.html new file mode 100644 index 0000000..5b618a9 --- /dev/null +++ b/hyde/layouts/doc/content/commandline.html @@ -0,0 +1,173 @@ +=== +title: Command Line +subtitle: working with hyde +created: 2011-01-27 11:02:43 +=== + +§§ blurb + +The hyde command line supports three subcommands: + +1. create - Initializes a new site at a given path +2. gen - Generates the website to a configured deploy folder +3. serve - Starts a local http server that regenerates based on the requested file + +§§ /blurb + +## The create command + +Creates a new hyde website. + +~~~sh~~~ +hyde create + +hyde [-s ] [-v] create [-l ] [-f] [-h] +~~~~~~~~ + +* `-s SITEPATH, --sitepath SITEPATH` + + Where the site must be created. If this path is not empty then the `-f` + option must be specified to overwrite the site. + + *Optional* - defaults to current working directory. + +* `-f, --force` + + Specifying this option will overwrite files and folders at the given + site path. + + *Optional* - If the target directory is not empty, hyde will throw an + exception unless this is specified. + +* `-l LAYOUT, --layout LAYOUT` + + The name of the layout to use for creating the initial site. Hyde currently + has three layouts: `basic`, `test` and `doc`. + + While basic and test are really barebones, doc is the one that generates + this documentation and is completely usable. Hyde will get more layouts + as over time. + + Hyde tries to locate the specified layout in the following folders: + + 1. In `layouts` folder under the path specified by the `HYDE_DATA` + environment variable + 2. In `layouts` folder under hyde + + *Optional* - defaults to `basic` + +* `-v, --verbose` + + Logs detailed messages to the console. + + *Optional* - shows only essential messages if this option is omitted. + +* `-h` + + Displays the help text for the `create` command. + +Assuming the `HYDE_DATA` environment variable is empty and the folder +`~/test` is empty, the following command will create a new hyde site +at `~/test` with the contents of `layouts/doc` folder: + +~~~sh~~~ +hyde -s ~/test create -l doc +~~~~~~~~ + +## The generate command + +Generates the given website. + +~~~sh~~~ +hyde gen + +hyde [-s ] [-v] gen [-d ] [-c ] [-h] +~~~~~~~~ + +* `-s SITEPATH, --sitepath SITEPATH` + + The path to the site to be generated. + + *Optional* - defaults to current working directory. + +* `-d DEPLOY_PATH, --deploy-path DEPLOY_PATH` + + Location where the site should be generated. This option overrides any + setting specified in the hyde [configuration][]. The path is assumed to + be relative to the site path unless a preceding path separator is found. + + *Optional* - Uses what is specified in the config file. The default option + in the configuration file is: `deploy` folder under the current site path. + + +* `-c CONFIG, --config-path CONFIG` + + This is used for specifying an alternate configuration file to use for + generating the site. This is useful if you have two different configurations + for you production versus development websites. + + The path is assumed to be relative to the site path unless a preceding path + separator is found. + + *Optional* - defaults to `site.yaml` + +* `-v, --verbose` + + Logs detailed messages to the console. + + *Optional* - shows only essential messages if this option is omitted. + +* `-h` + + Displays the help text for the `gen` command. + +The following command will use `production.yaml` as the configuration file and +generate the website at `~/test` to `~/production_site` directory. + +~~~sh~~~ +cd ~/test +hyde gen -c production.yaml -d ~/production_site +~~~~~~~~ + +## The serve command + +Starts the built in web server that also regenerates based on the request if there are +changes. + +~~~sh~~~ +hyde serve + +hyde [-s ] [-v] gen [-d ] [-c ] [-h] +~~~~~~~~ + +* `-s SITEPATH, --sitepath SITEPATH` + `-d DEPLOY_PATH, --deploy-path DEPLOY_PATH` + `-c CONFIG, --config-path CONFIG` + + Since the `serve` command auto generates if there is a need, it needs the same + parameters as the `gen` command. The above parameters serve the same purpose here + as in the `gen` command. + +* `-a ADDRESS, --address ADDRESS` + + The address to serve the website. + + *Optional* - defaults to `localhost` + +* `-p PORT, --port` + + The port to serve the website. + + *Optional* - default to `8080` + +* `-h` + + Displays the help text for the `serve` command. + +The following command will serve the website at `http://localhost:8181` + +~~~sh~~~ +cd ~/test +hyde serve -p 8181 +~~~~~~~~ + diff --git a/hyde/layouts/doc/content/install.html b/hyde/layouts/doc/content/install.html new file mode 100644 index 0000000..71e3f45 --- /dev/null +++ b/hyde/layouts/doc/content/install.html @@ -0,0 +1,54 @@ +=== +title: Installation +subtitle: PIPing hot hyde +created: 2011-01-26 23:17:44 +=== + +§§ blurb + +Installing hyde is as simple as running the following command: + +~~~sh~~~ +pip install -e https://github.com/hydepy/hyde#egg=hyde +~~~~~~~~ + +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 [plugin documentation][plugins]. + +§§ /blurb + +## Essential Requirements + +While your mileage may vary, I 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 them as part of hyde. + +It is also recommended that you use [virtualenv][] 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: + +1. `argparse`: argparse is required if you are on python 2.6. +2. `commando`: commando is a wrapper on top of argparse to give better syntax and + support for multi-command applications. +3. `Jinja2`: While hyde will support many more template languages in the future, + currently, Jinja2 is wholly supported and recommended. +4. `Markdown`: While there are plans to add support for other markups (textile, + restructured text, asciidoc etc..,), markdown is the one thats currently + completely supported. +5. `Pyyaml`: Much of hyde's [configuration] is done using yaml. +6. `Typogrify`: 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. +~~~sh~~~ +pip install argparse +pip install commando +pip install jinja2 +pip install markdown +pip install pyyaml +pip install -e https://github.com/hydepy/typogrify#egg=typogrify +~~~~~~~~ + +[plugins]: [[plugins]] +[virtualenv]: http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/ diff --git a/hyde/layouts/doc/content/media/css/inc/colors.less b/hyde/layouts/doc/content/media/css/inc/colors.less index 4e6e3a3..21ac6f6 100644 --- a/hyde/layouts/doc/content/media/css/inc/colors.less +++ b/hyde/layouts/doc/content/media/css/inc/colors.less @@ -7,4 +7,4 @@ @shade: #453F19; @glowing: #CD3B16; @light: #d4ffe3; -@clear: #ededed; +@clear: #fefdfd; diff --git a/hyde/layouts/doc/content/media/css/inc/layout.less b/hyde/layouts/doc/content/media/css/inc/layout.less index 8ae19bb..6e0dfc0 100644 --- a/hyde/layouts/doc/content/media/css/inc/layout.less +++ b/hyde/layouts/doc/content/media/css/inc/layout.less @@ -13,7 +13,7 @@ body{ } article{ - width: @totalwidth / 1.618; + width: @column * 10 + @gutter * 11; } h1, h2, h3, h4, h5, h6, p{ diff --git a/hyde/layouts/doc/content/media/css/inc/text.less b/hyde/layouts/doc/content/media/css/inc/text.less index 4844c80..686a66b 100644 --- a/hyde/layouts/doc/content/media/css/inc/text.less +++ b/hyde/layouts/doc/content/media/css/inc/text.less @@ -3,6 +3,8 @@ @text-font: "ff-meta-web-pro-1","ff-meta-web-pro-2", Helvetica, Arial, sans-serif; @caps-font: "anivers-1","anivers-2", Helvetica, Arial, sans-serif; + + .heading{ color: @clear - 40; text-shadow: -1px -1px 0px @clear - 90, 1px 1px 0px @clear + 90; @@ -14,6 +16,20 @@ body{ font-weight: normal; } +h1, h2, h3, h4, h5, h6{ + font-family: @heading-font; +} + +code, +.highlight pre{ + font-family: menlo, monaco, courier; +} + +code{ + color: @qdark; + font-size: 80%; +} + .amp { font-family: Baskerville, Palatino, "Book Antiqua", serif; line-height: 75%; diff --git a/hyde/layouts/doc/content/media/css/site.less b/hyde/layouts/doc/content/media/css/site.less index 0dd87af..ef38b8d 100644 --- a/hyde/layouts/doc/content/media/css/site.less +++ b/hyde/layouts/doc/content/media/css/site.less @@ -9,9 +9,9 @@ @import 'inc/controls'; h2 { - font-size: @gutter * 3; + font-size: @gutter * 2; color: @shade; - line-height: @gutter * 4; + line-height: @gutter * 2; } header.banner { @@ -25,17 +25,20 @@ header.banner { h1 { .heading; float: left; - margin-left: @column; + margin-left: @column - 2; font-size: @column * 2; - line-height: @column * 3; + line-height: @column * 3 + 8; margin-bottom: 0; } h3 { - color: @shade; + .subheading; + color: @qdark; position: absolute; - bottom: @gutter + 2; - left: @column * 6 - 4; + bottom: @gutter; + font-size: @gutter * 2; + left: @gutter * 22 + 2; margin:0; + text-shadow: -1px -1px 0px @clear - 90, 1px 1px 0px @clear + 90; } margin-bottom: @column; } @@ -43,12 +46,25 @@ header.banner { article { padding: @column; .boxshadow(0, 1px, 3px, @qdark); + + h1.title { + color: @dark; + font-size: @gutter * 3; + margin-bottom: @gutter / 2; + } + h3.subtitle{ + color: @shade; + font-size: @gutter * 1.5; + font-weight: normal; + padding-left: 6px; + border-bottom: 1px solid rgba(0, 0, 0, 0.1); + margin-bottom: @gutter * 2 - 3; + } } .highlight pre{ - font-size: @gutter; - font-family: menlo, monaco, courier; + font-size: @gutter - 1; .boxshadow(0, 1px, 3px, @qdark); - padding: @gutter; + padding: @gutter * 1.5 @gutter; } diff --git a/hyde/layouts/doc/content/overview.html b/hyde/layouts/doc/content/overview.html index d731220..cc3ffbf 100644 --- a/hyde/layouts/doc/content/overview.html +++ b/hyde/layouts/doc/content/overview.html @@ -6,8 +6,8 @@ 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] to have an identity of its own. +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 @@ -18,8 +18,8 @@ Hyde desires to fulfill the lofty goal of removing the * Support for powerful template languages like [Jinja2][] complemented with custom tags and filters. -* [Rich object model][hyde objects] and - [overridable hierarchical metadata][metadata] thats available for use in +* 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 @@ -27,10 +27,6 @@ Hyde desires to fulfill the lofty goal of removing the * Instant preview using built-in [webserver][server] that regenerates content if needed. -## Source - -Hyde is [socially coded][hydepy]. Feel free to [fork][forking]. - ## Install There will be a package soon on pypi, but this works for now: @@ -43,6 +39,39 @@ pip install -e https://github.com/hydepy/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 [command line documentation][commandline] +or run `hyde --h`. + +## Source + +Hyde is [socially coded][hydepy]. Feel free to [fork][forking]. + ## Project Roadmap 1. Support for Django and Mako @@ -63,17 +92,19 @@ You can find more detailed documentation in the [installation section][install]. 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/ -[hyde objects]: [[/template/variables]] +[object model]: [[template.html/#variables]] [hydepy]: https://github.com/hydepy/hyde -[install]: [[/install]] -[metadata]: [[/plugins/metadata]] -[plugins]: [[/plugins]] +[install]: [[install.html]] +[metadata]: [[plugins/metadata.html]] +[plugins]: [[plugins.html]] [python]: http://python.org -[server]: [[/server]] -[sorter]: [[plugins/sorter]] -[static cons]: [[/static/#cons]] -[static pros]: [[/static/#pros]] -[forking]: [[/contribute]] \ No newline at end of file +[server]: [[server.html]] +[sorter]: [[plugins/sorter.html]] +[static cons]: [[static.html/#cons]] +[static pros]: [static.html/#pros]] +[forking]: [[contribute.html]] +[commandline]: [[commandline.html]] \ No newline at end of file diff --git a/hyde/layouts/doc/layout/doc.j2 b/hyde/layouts/doc/layout/doc.j2 index 1877105..d6a16cb 100644 --- a/hyde/layouts/doc/layout/doc.j2 +++ b/hyde/layouts/doc/layout/doc.j2 @@ -1,6 +1,10 @@ {% extends "root.j2" %} {% block main -%}
      +
      +

      {{ resource.meta.title }}

      +

      {{ resource.meta.subtitle }}

      +
      {% filter markdown|typogrify -%} {% block doc -%} {%- endblock %} diff --git a/hyde/layouts/doc/layout/root.j2 b/hyde/layouts/doc/layout/root.j2 index 1dcec5c..90318cc 100644 --- a/hyde/layouts/doc/layout/root.j2 +++ b/hyde/layouts/doc/layout/root.j2 @@ -61,7 +61,7 @@