henshin 0.0.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (171) hide show
  1. data/.gitignore +2 -0
  2. data/VERSION +1 -1
  3. data/bin/henshin +7 -1
  4. data/henshin.gemspec +6 -149
  5. data/lib/henshin.rb +22 -6
  6. data/lib/henshin/categories.rb +19 -0
  7. data/lib/henshin/ext.rb +47 -2
  8. data/lib/henshin/gen.rb +8 -11
  9. data/lib/henshin/plugin.rb +9 -0
  10. data/lib/henshin/plugins/liquid.rb +1 -1
  11. data/lib/henshin/post.rb +38 -14
  12. data/lib/henshin/site.rb +68 -29
  13. data/lib/henshin/tags.rb +19 -0
  14. data/test/site/_site/2010/10/20-testing-stuff/index.html +14 -6
  15. data/test/site/_site/2010/5/15-lorem-ipsum/index.html +14 -6
  16. data/test/site/_site/css/print.css +10 -24
  17. data/test/site/_site/index.html +82 -1
  18. data/test/site/index.html +2 -0
  19. data/test/site/layouts/main.html +35 -1
  20. data/test/site/layouts/post.html +7 -5
  21. data/test/site/options.yaml +5 -2
  22. data/test/site/plugins/test.rb +11 -0
  23. data/test/site/posts/Testing-Stuff.markdown +1 -0
  24. metadata +7 -150
  25. data/.yardoc/checksums +0 -10
  26. data/.yardoc/objects/Hash.dat +0 -0
  27. data/.yardoc/objects/Hash/to_options_i.dat +0 -0
  28. data/.yardoc/objects/Henshin.dat +0 -0
  29. data/.yardoc/objects/Henshin/CSSGenerator.dat +0 -0
  30. data/.yardoc/objects/Henshin/CSSGenerator/generate_i.dat +0 -0
  31. data/.yardoc/objects/Henshin/Defaults.dat +0 -0
  32. data/.yardoc/objects/Henshin/Gen.dat +0 -0
  33. data/.yardoc/objects/Henshin/Gen/config_3D_i.dat +0 -0
  34. data/.yardoc/objects/Henshin/Gen/config_i.dat +0 -0
  35. data/.yardoc/objects/Henshin/Gen/content_3D_i.dat +0 -0
  36. data/.yardoc/objects/Henshin/Gen/content_i.dat +0 -0
  37. data/.yardoc/objects/Henshin/Gen/date_3D_i.dat +0 -0
  38. data/.yardoc/objects/Henshin/Gen/date_i.dat +0 -0
  39. data/.yardoc/objects/Henshin/Gen/extension_3D_i.dat +0 -0
  40. data/.yardoc/objects/Henshin/Gen/extension_i.dat +0 -0
  41. data/.yardoc/objects/Henshin/Gen/initialize_i.dat +0 -0
  42. data/.yardoc/objects/Henshin/Gen/layout_3D_i.dat +0 -0
  43. data/.yardoc/objects/Henshin/Gen/layout_i.dat +0 -0
  44. data/.yardoc/objects/Henshin/Gen/override_i.dat +0 -0
  45. data/.yardoc/objects/Henshin/Gen/path_3D_i.dat +0 -0
  46. data/.yardoc/objects/Henshin/Gen/path_i.dat +0 -0
  47. data/.yardoc/objects/Henshin/Gen/payload_i.dat +0 -0
  48. data/.yardoc/objects/Henshin/Gen/process_i.dat +0 -0
  49. data/.yardoc/objects/Henshin/Gen/read_yaml_i.dat +0 -0
  50. data/.yardoc/objects/Henshin/Gen/render_i.dat +0 -0
  51. data/.yardoc/objects/Henshin/Gen/site_3D_i.dat +0 -0
  52. data/.yardoc/objects/Henshin/Gen/site_i.dat +0 -0
  53. data/.yardoc/objects/Henshin/Gen/title_3D_i.dat +0 -0
  54. data/.yardoc/objects/Henshin/Gen/title_i.dat +0 -0
  55. data/.yardoc/objects/Henshin/Gen/write_i.dat +0 -0
  56. data/.yardoc/objects/Henshin/HTMLGenerator.dat +0 -0
  57. data/.yardoc/objects/Henshin/HTMLGenerator/generate_i.dat +0 -0
  58. data/.yardoc/objects/Henshin/JSGenerator.dat +0 -0
  59. data/.yardoc/objects/Henshin/JSGenerator/generate_i.dat +0 -0
  60. data/.yardoc/objects/Henshin/LayoutParser.dat +0 -0
  61. data/.yardoc/objects/Henshin/LayoutParser/generate_i.dat +0 -0
  62. data/.yardoc/objects/Henshin/Post.dat +0 -0
  63. data/.yardoc/objects/Henshin/Post/author_3D_i.dat +0 -0
  64. data/.yardoc/objects/Henshin/Post/author_i.dat +0 -0
  65. data/.yardoc/objects/Henshin/Post/category_3D_i.dat +0 -0
  66. data/.yardoc/objects/Henshin/Post/category_i.dat +0 -0
  67. data/.yardoc/objects/Henshin/Post/date_3D_i.dat +0 -0
  68. data/.yardoc/objects/Henshin/Post/date_i.dat +0 -0
  69. data/.yardoc/objects/Henshin/Post/initialize_i.dat +0 -0
  70. data/.yardoc/objects/Henshin/Post/override_i.dat +0 -0
  71. data/.yardoc/objects/Henshin/Post/payload_i.dat +0 -0
  72. data/.yardoc/objects/Henshin/Post/permalink_i.dat +0 -0
  73. data/.yardoc/objects/Henshin/Post/process_i.dat +0 -0
  74. data/.yardoc/objects/Henshin/Post/read_name_i.dat +0 -0
  75. data/.yardoc/objects/Henshin/Post/read_yaml_i.dat +0 -0
  76. data/.yardoc/objects/Henshin/Post/tags_3D_i.dat +0 -0
  77. data/.yardoc/objects/Henshin/Post/tags_i.dat +0 -0
  78. data/.yardoc/objects/Henshin/Post/title_3D_i.dat +0 -0
  79. data/.yardoc/objects/Henshin/Post/title_i.dat +0 -0
  80. data/.yardoc/objects/Henshin/Post/write_i.dat +0 -0
  81. data/.yardoc/objects/Henshin/Site.dat +0 -0
  82. data/.yardoc/objects/Henshin/Site/archives_3D_i.dat +0 -0
  83. data/.yardoc/objects/Henshin/Site/archives_i.dat +0 -0
  84. data/.yardoc/objects/Henshin/Site/categories_3D_i.dat +0 -0
  85. data/.yardoc/objects/Henshin/Site/categories_i.dat +0 -0
  86. data/.yardoc/objects/Henshin/Site/config_3D_i.dat +0 -0
  87. data/.yardoc/objects/Henshin/Site/config_i.dat +0 -0
  88. data/.yardoc/objects/Henshin/Site/gens_3D_i.dat +0 -0
  89. data/.yardoc/objects/Henshin/Site/gens_i.dat +0 -0
  90. data/.yardoc/objects/Henshin/Site/initialize_i.dat +0 -0
  91. data/.yardoc/objects/Henshin/Site/layouts_3D_i.dat +0 -0
  92. data/.yardoc/objects/Henshin/Site/layouts_i.dat +0 -0
  93. data/.yardoc/objects/Henshin/Site/payload_i.dat +0 -0
  94. data/.yardoc/objects/Henshin/Site/plugins_3D_i.dat +0 -0
  95. data/.yardoc/objects/Henshin/Site/plugins_i.dat +0 -0
  96. data/.yardoc/objects/Henshin/Site/posts_3D_i.dat +0 -0
  97. data/.yardoc/objects/Henshin/Site/posts_i.dat +0 -0
  98. data/.yardoc/objects/Henshin/Site/process_i.dat +0 -0
  99. data/.yardoc/objects/Henshin/Site/read_i.dat +0 -0
  100. data/.yardoc/objects/Henshin/Site/read_layouts_i.dat +0 -0
  101. data/.yardoc/objects/Henshin/Site/read_others_i.dat +0 -0
  102. data/.yardoc/objects/Henshin/Site/read_posts_i.dat +0 -0
  103. data/.yardoc/objects/Henshin/Site/render_i.dat +0 -0
  104. data/.yardoc/objects/Henshin/Site/reset_i.dat +0 -0
  105. data/.yardoc/objects/Henshin/Site/statics_3D_i.dat +0 -0
  106. data/.yardoc/objects/Henshin/Site/statics_i.dat +0 -0
  107. data/.yardoc/objects/Henshin/Site/tags_3D_i.dat +0 -0
  108. data/.yardoc/objects/Henshin/Site/tags_i.dat +0 -0
  109. data/.yardoc/objects/Henshin/Site/write_i.dat +0 -0
  110. data/.yardoc/objects/Henshin/StandardPlugin.dat +0 -0
  111. data/.yardoc/objects/Henshin/configure_c.dat +0 -0
  112. data/.yardoc/objects/Henshin/extensions_c.dat +0 -0
  113. data/.yardoc/objects/Henshin/load_plugins_c.dat +0 -0
  114. data/.yardoc/objects/LiquidPlugin.dat +0 -0
  115. data/.yardoc/objects/LiquidPlugin/extensions_3D_i.dat +0 -0
  116. data/.yardoc/objects/LiquidPlugin/extensions_i.dat +0 -0
  117. data/.yardoc/objects/LiquidPlugin/generate_i.dat +0 -0
  118. data/.yardoc/objects/LiquidPlugin/initialize_i.dat +0 -0
  119. data/.yardoc/objects/LiquidPlugin/read_i.dat +0 -0
  120. data/.yardoc/objects/MarukuPlugin.dat +0 -0
  121. data/.yardoc/objects/MarukuPlugin/extensions_3D_i.dat +0 -0
  122. data/.yardoc/objects/MarukuPlugin/extensions_i.dat +0 -0
  123. data/.yardoc/objects/MarukuPlugin/generate_i.dat +0 -0
  124. data/.yardoc/objects/MarukuPlugin/initialize_i.dat +0 -0
  125. data/.yardoc/objects/PygmentsPlugin.dat +0 -0
  126. data/.yardoc/objects/PygmentsPlugin/extensions_3D_i.dat +0 -0
  127. data/.yardoc/objects/PygmentsPlugin/extensions_i.dat +0 -0
  128. data/.yardoc/objects/PygmentsPlugin/generate_i.dat +0 -0
  129. data/.yardoc/objects/PygmentsPlugin/initialize_i.dat +0 -0
  130. data/.yardoc/objects/SassPlugin.dat +0 -0
  131. data/.yardoc/objects/SassPlugin/extensions_3D_i.dat +0 -0
  132. data/.yardoc/objects/SassPlugin/extensions_i.dat +0 -0
  133. data/.yardoc/objects/SassPlugin/generate_i.dat +0 -0
  134. data/.yardoc/objects/SassPlugin/initialize_i.dat +0 -0
  135. data/.yardoc/objects/String.dat +0 -0
  136. data/.yardoc/objects/String/directory_i.dat +0 -0
  137. data/.yardoc/objects/String/extension_i.dat +0 -0
  138. data/.yardoc/objects/String/file_name_i.dat +0 -0
  139. data/.yardoc/objects/String/slugify_i.dat +0 -0
  140. data/.yardoc/objects/root.dat +0 -0
  141. data/.yardoc/proxy_types +0 -2
  142. data/doc/Hash.html +0 -179
  143. data/doc/Henshin.html +0 -479
  144. data/doc/Henshin/CSSGenerator.html +0 -186
  145. data/doc/Henshin/Gen.html +0 -1225
  146. data/doc/Henshin/HTMLGenerator.html +0 -186
  147. data/doc/Henshin/JSGenerator.html +0 -182
  148. data/doc/Henshin/LayoutParser.html +0 -186
  149. data/doc/Henshin/Post.html +0 -1159
  150. data/doc/Henshin/Site.html +0 -1462
  151. data/doc/Henshin/StandardPlugin.html +0 -99
  152. data/doc/LiquidPlugin.html +0 -399
  153. data/doc/MarukuPlugin.html +0 -325
  154. data/doc/PygmentsPlugin.html +0 -325
  155. data/doc/SassPlugin.html +0 -325
  156. data/doc/String.html +0 -371
  157. data/doc/_index.html +0 -239
  158. data/doc/class_list.html +0 -36
  159. data/doc/css/common.css +0 -1
  160. data/doc/css/full_list.css +0 -50
  161. data/doc/css/style.css +0 -273
  162. data/doc/file.README.html +0 -133
  163. data/doc/file_list.html +0 -38
  164. data/doc/frames.html +0 -13
  165. data/doc/index.html +0 -133
  166. data/doc/js/app.js +0 -111
  167. data/doc/js/full_list.js +0 -117
  168. data/doc/js/jquery.js +0 -19
  169. data/doc/method_list.html +0 -611
  170. data/doc/top-level-namespace.html +0 -89
  171. data/test/site/_site/css/screen.css +0 -15
data/doc/file.README.html DELETED
@@ -1,133 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta name="Content-Type" content="text/html; charset=utf-8" />
6
- <title>Documentation by YARD 0.5.4</title>
7
- <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
8
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
-
10
- <script type="text/javascript" charset="utf-8">
11
- relpath = '';
12
- if (relpath != '') relpath += '/';
13
- </script>
14
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
15
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
16
-
17
- </head>
18
- <body>
19
- <script type="text/javascript" charset="utf-8">
20
- if (window.top.frames.main) document.body.className = 'frames';
21
- </script>
22
-
23
- <div id="header">
24
- <div id="menu">
25
-
26
- <a href="_index.html" title="Index">Index</a> &raquo;
27
- <span class="title">File: README</span>
28
-
29
-
30
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
31
- </div>
32
-
33
- <div id="search">
34
- <a id="class_list_link" href="#">Class List</a>
35
- <a id="method_list_link" href="#">Method List</a>
36
- <a id ="file_list_link" href="#">File List</a>
37
- </div>
38
-
39
- <div class="clear"></div>
40
- </div>
41
-
42
- <iframe id="search_frame"></iframe>
43
-
44
- <div id="content"><div id='filecontents'><h1 id='henshin'>Henshin</h1>
45
-
46
- <p>Henshin is a new static site generator, yeah another one. I wasn&#8217;t going to release it yet but then I saw <a href='http://awestruct.org/'>awestruct</a> and thought I may as well now. Oh and this was totally inspired by the amazing <a href='http://github.com/mojombo/jekyll'>jekyll</a> (in case you hadn&#8217;t guessed).</p>
47
-
48
- <h2 id='main_features'>Main Features</h2>
49
-
50
- <ul>
51
- <li>Generates posts, etc.</li>
52
-
53
- <li>More control with settings (see below)</li>
54
-
55
- <li>A plugin system (not great at the moment, still working on how best to implement it)</li>
56
- </ul>
57
-
58
- <h2 id='future_goals'>Future Goals</h2>
59
-
60
- <ul>
61
- <li>Ability to regenerate only files that have changed</li>
62
-
63
- <li>Easy tag, category and archive pages</li>
64
-
65
- <li>Default templates so you can just type <code>henshin</code> with any folder of text files and create a quick site</li>
66
- </ul>
67
-
68
- <h2 id='how_to'>How To</h2>
69
-
70
- <p>Install by typing <code>(sudo) gem install henshin</code></p>
71
-
72
- <p>Then create a folder for your site, in this you&#8217;ll probably want to create two folders <code>layouts</code> and <code>posts</code>, to put in your layouts and posts.</p>
73
-
74
- <p>Next create an <code>index.html</code> file and your kind of done, unless of course you want some content.</p>
75
-
76
- <p>Build the site by running <code>henshin</code> from the command line. Help available with <code>henshin -h</code></p>
77
-
78
- <h3 id='yaml_frontmatter__optionsyaml'>YAML Frontmatter &amp; Options.yaml</h3>
79
-
80
- <p>You can create an optional <code>options.yaml</code> file at the root of your site, here are the options so far:</p>
81
-
82
- <pre class="code">title: [title of your site]
83
- description: [description for your site]
84
- author: [your name]
85
-
86
- layout: [the default layout to use]
87
-
88
- post_name: [the way the post name is parsed]
89
- eg. '{title-with-dashes}.{extension}
90
-
91
- you can use:
92
- {title}
93
- {title-with-dashes}
94
- {date}
95
- {date-time}
96
- {extension}
97
-
98
- permalink: [the way you want the permalink to look]
99
- eg. '/{year}/{month}/{date}-{title}/index.html
100
- these are the only options at the moment for permalink
101
-
102
- plugins: [array of plugins to </pre>
103
-
104
- <h3 id='plugins'>Plugins</h3>
105
-
106
- <p>The only plugins at the moment are the ones included (liquid, maruku, sass and pygments) of which only liquid and maruku work at the moment. In the future you will be able to add your own plugins, probably in a plugins folder. If you want to make your own just look at the others, it&#8217;s pretty simple to work out!</p>
107
-
108
- <h2 id='note_on_patchespull_requests'>Note on Patches/Pull Requests</h2>
109
-
110
- <ul>
111
- <li>Fork the project</li>
112
-
113
- <li>Make your feature addition or bug fix</li>
114
-
115
- <li>Add tests for it. This is important so I don&#8217;t break it in a future version unintentionally.</li>
116
-
117
- <li>Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)</li>
118
-
119
- <li>Send me a pull request. Bonus points for topic branches.</li>
120
- </ul>
121
-
122
- <h2 id='license'>License</h2>
123
-
124
- <p>Copyright (c) 2010 Joshua Hawxwell. See LICENSE for details.</p></div></div>
125
-
126
- <div id="footer">
127
- Generated on Wed May 19 15:05:31 2010 by
128
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
129
- 0.5.4 (ruby-1.9.1).
130
- </div>
131
-
132
- </body>
133
- </html>
data/doc/file_list.html DELETED
@@ -1,38 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html>
4
- <head>
5
- <meta name="Content-Type" content="text/html; charset=utf-8" />
6
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
7
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
8
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
9
- <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
10
- <base id="base_target" target="_parent" />
11
- </head>
12
- <body>
13
- <script type="text/javascript" charset="utf-8">
14
- if (window.top.frames.main) {
15
- document.getElementById('base_target').target = 'main';
16
- document.body.className = 'frames';
17
- }
18
- </script>
19
- <div id="content">
20
- <h1 id="full_list_header">File List</h1>
21
- <div id="nav">
22
- <a target="_self" href="class_list.html">Classes</a> |
23
- <a target="_self" href="method_list.html">Methods</a> |
24
- <a target="_self" href="file_list.html">Files</a>
25
- </div>
26
- <div id="search">Search: <input type="text" /></div>
27
-
28
- <ul id="full_list" class="files">
29
-
30
-
31
- <li class="r1"><a href="index.html" title="README">README</a></li>
32
-
33
-
34
- </ul>
35
- </div>
36
- </body>
37
- </html>
38
-
data/doc/frames.html DELETED
@@ -1,13 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
-
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
- <title>Documentation by YARD 0.5.4</title>
8
- </head>
9
- <frameset cols="20%,*">
10
- <frame name="list" src="class_list.html" />
11
- <frame name="main" src="index.html" />
12
- </frameset>
13
- </html>
data/doc/index.html DELETED
@@ -1,133 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta name="Content-Type" content="text/html; charset=utf-8" />
6
- <title>Documentation by YARD 0.5.4</title>
7
- <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
8
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
-
10
- <script type="text/javascript" charset="utf-8">
11
- relpath = '';
12
- if (relpath != '') relpath += '/';
13
- </script>
14
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
15
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
16
-
17
- </head>
18
- <body>
19
- <script type="text/javascript" charset="utf-8">
20
- if (window.top.frames.main) document.body.className = 'frames';
21
- </script>
22
-
23
- <div id="header">
24
- <div id="menu">
25
-
26
- <a href="_index.html" title="Index">Index</a> &raquo;
27
- <span class="title">File: README</span>
28
-
29
-
30
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
31
- </div>
32
-
33
- <div id="search">
34
- <a id="class_list_link" href="#">Class List</a>
35
- <a id="method_list_link" href="#">Method List</a>
36
- <a id ="file_list_link" href="#">File List</a>
37
- </div>
38
-
39
- <div class="clear"></div>
40
- </div>
41
-
42
- <iframe id="search_frame"></iframe>
43
-
44
- <div id="content"><div id='filecontents'><h1 id='henshin'>Henshin</h1>
45
-
46
- <p>Henshin is a new static site generator, yeah another one. I wasn&#8217;t going to release it yet but then I saw <a href='http://awestruct.org/'>awestruct</a> and thought I may as well now. Oh and this was totally inspired by the amazing <a href='http://github.com/mojombo/jekyll'>jekyll</a> (in case you hadn&#8217;t guessed).</p>
47
-
48
- <h2 id='main_features'>Main Features</h2>
49
-
50
- <ul>
51
- <li>Generates posts, etc.</li>
52
-
53
- <li>More control with settings (see below)</li>
54
-
55
- <li>A plugin system (not great at the moment, still working on how best to implement it)</li>
56
- </ul>
57
-
58
- <h2 id='future_goals'>Future Goals</h2>
59
-
60
- <ul>
61
- <li>Ability to regenerate only files that have changed</li>
62
-
63
- <li>Easy tag, category and archive pages</li>
64
-
65
- <li>Default templates so you can just type <code>henshin</code> with any folder of text files and create a quick site</li>
66
- </ul>
67
-
68
- <h2 id='how_to'>How To</h2>
69
-
70
- <p>Install by typing <code>(sudo) gem install henshin</code></p>
71
-
72
- <p>Then create a folder for your site, in this you&#8217;ll probably want to create two folders <code>layouts</code> and <code>posts</code>, to put in your layouts and posts.</p>
73
-
74
- <p>Next create an <code>index.html</code> file and your kind of done, unless of course you want some content.</p>
75
-
76
- <p>Build the site by running <code>henshin</code> from the command line. Help available with <code>henshin -h</code></p>
77
-
78
- <h3 id='yaml_frontmatter__optionsyaml'>YAML Frontmatter &amp; Options.yaml</h3>
79
-
80
- <p>You can create an optional <code>options.yaml</code> file at the root of your site, here are the options so far:</p>
81
-
82
- <pre class="code">title: [title of your site]
83
- description: [description for your site]
84
- author: [your name]
85
-
86
- layout: [the default layout to use]
87
-
88
- post_name: [the way the post name is parsed]
89
- eg. '{title-with-dashes}.{extension}
90
-
91
- you can use:
92
- {title}
93
- {title-with-dashes}
94
- {date}
95
- {date-time}
96
- {extension}
97
-
98
- permalink: [the way you want the permalink to look]
99
- eg. '/{year}/{month}/{date}-{title}/index.html
100
- these are the only options at the moment for permalink
101
-
102
- plugins: [array of plugins to </pre>
103
-
104
- <h3 id='plugins'>Plugins</h3>
105
-
106
- <p>The only plugins at the moment are the ones included (liquid, maruku, sass and pygments) of which only liquid and maruku work at the moment. In the future you will be able to add your own plugins, probably in a plugins folder. If you want to make your own just look at the others, it&#8217;s pretty simple to work out!</p>
107
-
108
- <h2 id='note_on_patchespull_requests'>Note on Patches/Pull Requests</h2>
109
-
110
- <ul>
111
- <li>Fork the project</li>
112
-
113
- <li>Make your feature addition or bug fix</li>
114
-
115
- <li>Add tests for it. This is important so I don&#8217;t break it in a future version unintentionally.</li>
116
-
117
- <li>Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)</li>
118
-
119
- <li>Send me a pull request. Bonus points for topic branches.</li>
120
- </ul>
121
-
122
- <h2 id='license'>License</h2>
123
-
124
- <p>Copyright (c) 2010 Joshua Hawxwell. See LICENSE for details.</p></div></div>
125
-
126
- <div id="footer">
127
- Generated on Wed May 19 15:05:31 2010 by
128
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
129
- 0.5.4 (ruby-1.9.1).
130
- </div>
131
-
132
- </body>
133
- </html>
data/doc/js/app.js DELETED
@@ -1,111 +0,0 @@
1
- function createSourceLinks() {
2
- $('.method_details_list .source_code').
3
- before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
4
- $('.toggleSource').toggle(function() {
5
- $(this).parent().next().slideDown(100);
6
- $(this).text("Hide source");
7
- },
8
- function() {
9
- $(this).parent().next().slideUp(100);
10
- $(this).text("View source");
11
- });
12
- }
13
-
14
- function createDefineLinks() {
15
- var tHeight = 0;
16
- $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
17
- $('.toggleDefines').toggle(function() {
18
- tHeight = $(this).parent().prev().height();
19
- $(this).prev().show();
20
- $(this).parent().prev().height($(this).parent().height());
21
- $(this).text("(less)");
22
- },
23
- function() {
24
- $(this).prev().hide();
25
- $(this).parent().prev().height(tHeight);
26
- $(this).text("more...")
27
- });
28
- }
29
-
30
- function createFullTreeLinks() {
31
- var tHeight = 0;
32
- $('.inheritanceTree').toggle(function() {
33
- tHeight = $(this).parent().prev().height();
34
- $(this).prev().prev().hide();
35
- $(this).prev().show();
36
- $(this).text("(hide)");
37
- $(this).parent().prev().height($(this).parent().height());
38
- },
39
- function() {
40
- $(this).prev().prev().show();
41
- $(this).prev().hide();
42
- $(this).parent().prev().height(tHeight);
43
- $(this).text("show all")
44
- });
45
- }
46
-
47
- function fixBoxInfoHeights() {
48
- $('dl.box dd.r1, dl.box dd.r2').each(function() {
49
- $(this).prev().height($(this).height());
50
- });
51
- }
52
-
53
- function searchFrameLinks() {
54
- $('#method_list_link').click(function() {
55
- toggleSearchFrame(this, relpath + 'method_list.html');
56
- });
57
-
58
- $('#class_list_link').click(function() {
59
- toggleSearchFrame(this, relpath + 'class_list.html');
60
- });
61
-
62
- $('#file_list_link').click(function() {
63
- toggleSearchFrame(this, relpath + 'file_list.html');
64
- });
65
- }
66
-
67
- function toggleSearchFrame(id, link) {
68
- var frame = $('#search_frame');
69
- $('#search a').removeClass('active').addClass('inactive');
70
- if (frame.attr('src') == link && frame.css('display') != "none") {
71
- frame.slideUp(100);
72
- $('#search a').removeClass('active inactive');
73
- }
74
- else {
75
- $(id).addClass('active').removeClass('inactive');
76
- frame.attr('src', link).slideDown(100);
77
- }
78
- }
79
-
80
- function linkSummaries() {
81
- $('.summary_signature').click(function() {
82
- document.location = $(this).find('a').attr('href');
83
- });
84
- }
85
-
86
- function framesInit() {
87
- if (window.top.frames.main) {
88
- document.body.className = 'frames';
89
- $('#menu .noframes a').attr('href', document.location);
90
- }
91
- }
92
-
93
- function keyboardShortcuts() {
94
- $(document).keypress(function(evt) {
95
- if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
96
- switch (evt.charCode) {
97
- case 67: case 99: $('#class_list_link').click(); break; // 'c'
98
- case 77: case 109: $('#method_list_link').click(); break; // 'm'
99
- case 70: case 102: $('#file_list_link').click(); break; // 'f'
100
- }
101
- });
102
- }
103
-
104
- $(framesInit);
105
- $(createSourceLinks);
106
- $(createDefineLinks);
107
- $(createFullTreeLinks);
108
- $(fixBoxInfoHeights);
109
- $(searchFrameLinks);
110
- $(linkSummaries);
111
- $(keyboardShortcuts);
data/doc/js/full_list.js DELETED
@@ -1,117 +0,0 @@
1
- function fullListSearch() {
2
- $('#search input').keyup(function() {
3
- var value = this.value.toLowerCase();
4
- if (value == "") {
5
- $('#full_list').removeClass('insearch');
6
- $('#full_list li').each(function() {
7
- var link = $(this).children('a:last');
8
- link.text(link.text());
9
- });
10
- if (clicked) {
11
- clicked.parents('ul').each(function() {
12
- $(this).removeClass('collapsed').prev().removeClass('collapsed');
13
- });
14
- }
15
- highlight();
16
- }
17
- else {
18
- $('#full_list').addClass('insearch');
19
- $('#full_list li').each(function() {
20
- var link = $(this).children('a:last');
21
- var text = link.text();
22
- if (text.toLowerCase().indexOf(value) == -1) {
23
- $(this).removeClass('found');
24
- link.text(link.text());
25
- }
26
- else {
27
- $(this).css('padding-left', '10px').addClass('found');
28
- link.html(link.text().replace(new RegExp("(" +
29
- value.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"),
30
- '<strong>$1</strong>'));
31
- }
32
- });
33
- highlight(true);
34
- }
35
-
36
- if ($('#full_list li:visible').size() == 0) {
37
- $('#noresults').fadeIn();
38
- }
39
- else {
40
- $('#noresults').hide();
41
- }
42
- });
43
-
44
- $('#search input').focus();
45
- $('#full_list').after("<div id='noresults'>No results were found.</div>")
46
- }
47
-
48
- clicked = null;
49
- function linkList() {
50
- $('#full_list li, #full_list li a:last').click(function(evt) {
51
- if ($(this).hasClass('toggle')) return true;
52
- if (this.tagName.toLowerCase() == "li") {
53
- var toggle = $(this).children('a.toggle');
54
- if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
55
- toggle.click();
56
- return false;
57
- }
58
- }
59
- if (clicked) clicked.removeClass('clicked');
60
- var win = window.parent;
61
- if (window.top.frames.main) {
62
- win = window.top.frames.main;
63
- var title = $('html head title', win.document).text();
64
- $('html head title', window.parent.document).text(title);
65
- }
66
- if (this.tagName.toLowerCase() == "a") {
67
- clicked = $(this).parent('li').addClass('clicked');
68
- win.location = this.href;
69
- }
70
- else {
71
- clicked = $(this).addClass('clicked');
72
- win.location = $(this).find('a:last').attr('href');
73
- }
74
- return false;
75
- });
76
- }
77
-
78
- function collapse() {
79
- if (!$('#full_list').hasClass('class')) return;
80
- $('#full_list.class a.toggle').click(function() {
81
- $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
82
- highlight();
83
- return false;
84
- });
85
- $('#full_list.class ul').each(function() {
86
- $(this).addClass('collapsed').prev().addClass('collapsed');
87
- });
88
- $('#full_list.class').children().removeClass('collapsed');
89
- highlight();
90
- }
91
-
92
- function highlight(no_padding) {
93
- var n = 1;
94
- $('#full_list li:visible').each(function() {
95
- var next = n == 1 ? 2 : 1;
96
- $(this).removeClass("r" + next).addClass("r" + n);
97
- if (!no_padding && $('#full_list').hasClass('class')) {
98
- $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
99
- }
100
- n = next;
101
- });
102
- }
103
-
104
- function escapeShortcut() {
105
- $(document).keydown(function(evt) {
106
- if (evt.which == 27) {
107
- $('#search_frame', window.top.document).slideUp(100);
108
- $('#search a', window.top.document).removeClass('active inactive')
109
- $(window.top).focus();
110
- }
111
- });
112
- }
113
-
114
- $(escapeShortcut);
115
- $(fullListSearch);
116
- $(linkList);
117
- $(collapse);