Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 80 lines (54 sloc) 2.35 kb
2fcfcf1 @jgm Initial commit.
authored
1 = ecstatic
2
3 * http://github.com/jgm/ecstatic
4
5 == DESCRIPTION:
6
7 ecstatic helps you manage a static website. Pages are generated
8 from tenjin templates and YAML data files.
9
10 == FEATURES:
11
12 * Generates a static site, for high performance and security
13 * Separation of data and presentation, as in a dynamic web framework,
14 but with data in text files rather than databases
15 * Supports markdown
16 * Supports output in HTML, plain text, and LaTeX
17
18 == SYNOPSIS:
19
20 First, generate a site skeleton:
21
22 ecstatic mysite
23
24 See what has been done:
25
26 cd mysite
27 ls
28
29 To build the site (in the <tt>site</tt> directory):
30
31 rake
32
33 Try modifying the layout (<tt>standard.rbhtml</tt>),
34 the data (<tt>events.yaml</tt>), or the template
35 (<tt>events.rbhtml</tt>). Recompile the site with rake.
36
37 If you want to add new pages, just add templates and
38 datafiles, and register the pages in <tt>siteindex.yaml</tt>.
39 Put any static files in <tt>files</tt>; these will be copied
40 verbatim into the site.
41
42 If a page has no dynamic elements (other than the ones handled
43 by the layout), you can use a markdown file instead of a
44 template. Just give it the extension <tt>.markdown</tt>
45
46 == REQUIREMENTS:
47
48 * rpeg-markdown
49 * tenjin
50 * activesupport
51
52 == INSTALL:
53
54 * sudo gem install ecstatic
55
56 == LICENSE:
57
58 (The MIT License)
59
60 Copyright (c) 2009 John MacFarlane
61
62 Permission is hereby granted, free of charge, to any person obtaining
63 a copy of this software and associated documentation files (the
64 'Software'), to deal in the Software without restriction, including
65 without limitation the rights to use, copy, modify, merge, publish,
66 distribute, sublicense, and/or sell copies of the Software, and to
67 permit persons to whom the Software is furnished to do so, subject to
68 the following conditions:
69
70 The above copyright notice and this permission notice shall be
71 included in all copies or substantial portions of the Software.
72
73 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
74 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
75 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
76 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
77 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
78 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
79 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.