Permalink
Browse files

Added note about previewing site with maid.

  • Loading branch information...
1 parent d0bf4d5 commit 3bb21449c883ed2399bbcc195674dd14b6e1b83f @jgm committed Aug 3, 2009
Showing with 21 additions and 0 deletions.
  1. +21 −0 README.markdown
View
@@ -481,6 +481,27 @@ are rendered:
- `$sitetitle$`: the site title from `config.yaml`
- `$pagetitle$`: the page title as defined in `index.yaml`
+### Previewing a site
+
+If you use only relative URLs in your site, you can preview it by
+opening any of the HTML files in site in your web browser. If you use
+absolute links, this won't work, but you can use Jinjing Wang's simple
+static web server `maid`:
+
+ cabal update
+ cabal install maid
+
+To use maid to preview your site, just change to the site directory and
+start `maid`:
+
+ cd site
+ maid
+
+The site will appear at <http://localhost:3000>. If you want to serve it
+at another port, just pass the port number as an argument to `maid`:
+
+ maid 5999
+
[string template]: http://www.stringtemplate.org/
[YAML]: http://www.yaml.org/

0 comments on commit 3bb2144

Please sign in to comment.