utopia 2.5.5 → 2.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +1 -2
- data/Gemfile +1 -0
- data/Rakefile +2 -0
- data/docs/code/Utopia.html +439 -433
- data/docs/code/Utopia/Command.html +201 -195
- data/docs/code/Utopia/Command/Environment.html +244 -244
- data/docs/code/Utopia/Command/Server.html +202 -202
- data/docs/code/Utopia/Command/Server/Create.html +192 -192
- data/docs/code/Utopia/Command/Server/Update.html +235 -235
- data/docs/code/Utopia/Command/Site.html +269 -263
- data/docs/code/Utopia/Command/Site/Create.html +192 -192
- data/docs/code/Utopia/Command/Site/Update.html +246 -246
- data/docs/code/Utopia/Command/Top.html +244 -244
- data/docs/code/Utopia/Content.html +636 -630
- data/docs/code/Utopia/Content/Document.html +1411 -1407
- data/docs/code/Utopia/Content/Document/State.html +1048 -1048
- data/docs/code/Utopia/Content/Link.html +1023 -1023
- data/docs/code/Utopia/Content/Links.html +629 -623
- data/docs/code/Utopia/Content/MarkupParser.html +702 -702
- data/docs/code/Utopia/Content/MarkupParser/ParsedTag.html +375 -375
- data/docs/code/Utopia/Content/MarkupParser/UnbalancedTagError.html +523 -523
- data/docs/code/Utopia/Content/Namespace.html +416 -416
- data/docs/code/Utopia/Content/Node.html +952 -952
- data/docs/code/Utopia/Content/Node/Context.html +790 -790
- data/docs/code/Utopia/Content/Response.html +686 -686
- data/docs/code/Utopia/Content/SymbolicHash.html +365 -365
- data/docs/code/Utopia/Content/Tags.html +134 -134
- data/docs/code/Utopia/Content/UnbalancedTagError.html +270 -270
- data/docs/code/Utopia/ContentLength.html +298 -294
- data/docs/code/Utopia/Controller.html +657 -651
- data/docs/code/Utopia/Controller/Actions.html +260 -260
- data/docs/code/Utopia/Controller/Actions/Action.html +785 -779
- data/docs/code/Utopia/Controller/Actions/ClassMethods.html +360 -360
- data/docs/code/Utopia/Controller/Base.html +989 -989
- data/docs/code/Utopia/Controller/Respond.html +264 -254
- data/docs/code/Utopia/Controller/Respond/ClassMethods.html +207 -207
- data/docs/code/Utopia/Controller/Respond/Converter.html +219 -219
- data/docs/code/Utopia/Controller/Respond/Converter/Callback.html +425 -425
- data/docs/code/Utopia/Controller/Respond/Converter/ToJSON.html +323 -317
- data/docs/code/Utopia/Controller/Respond/Passthrough.html +266 -260
- data/docs/code/Utopia/Controller/Respond/Responder.html +449 -443
- data/docs/code/Utopia/Controller/Rewrite.html +260 -260
- data/docs/code/Utopia/Controller/Rewrite/ClassMethods.html +216 -216
- data/docs/code/Utopia/Controller/Rewrite/ExtractPrefixRule.html +303 -303
- data/docs/code/Utopia/Controller/Rewrite/Rewriter.html +402 -402
- data/docs/code/Utopia/Controller/Rewrite/Rule.html +193 -193
- data/docs/code/Utopia/Controller/Variables.html +428 -428
- data/docs/code/Utopia/Controllers.html +216 -216
- data/docs/code/Utopia/Exceptions.html +125 -125
- data/docs/code/Utopia/Exceptions/Handler.html +405 -405
- data/docs/code/Utopia/Exceptions/Mailer.html +400 -394
- data/docs/code/Utopia/Extensions.html +116 -116
- data/docs/code/Utopia/Extensions/ArraySplit.html +164 -164
- data/docs/code/Utopia/Extensions/DateTimeComparison.html +173 -173
- data/docs/code/Utopia/Extensions/TimeDateComparison.html +173 -173
- data/docs/code/Utopia/HTTP.html +193 -187
- data/docs/code/Utopia/HTTP/Status.html +355 -355
- data/docs/code/Utopia/Locale.html +522 -522
- data/docs/code/Utopia/Localization.html +886 -880
- data/docs/code/Utopia/Localization/Wrapper.html +403 -403
- data/docs/code/Utopia/Logger.html +185 -185
- data/docs/code/Utopia/Logger/CompactFormatter.html +290 -290
- data/docs/code/Utopia/Path.html +2562 -2556
- data/docs/code/Utopia/Path/Matcher.html +395 -395
- data/docs/code/Utopia/Path/Matcher/MatchData.html +418 -418
- data/docs/code/Utopia/Redirection.html +148 -142
- data/docs/code/Utopia/Redirection/ClientRedirect.html +594 -594
- data/docs/code/Utopia/Redirection/DirectoryIndex.html +265 -265
- data/docs/code/Utopia/Redirection/Errors.html +391 -385
- data/docs/code/Utopia/Redirection/Moved.html +265 -265
- data/docs/code/Utopia/Redirection/RequestFailure.html +201 -201
- data/docs/code/Utopia/Redirection/Rewrite.html +265 -265
- data/docs/code/Utopia/Session.html +723 -717
- data/docs/code/Utopia/Session/LazyHash.html +709 -709
- data/docs/code/Utopia/Setup.html +783 -777
- data/docs/code/Utopia/Static.html +516 -510
- data/docs/code/Utopia/Static/LocalFile.html +875 -869
- data/docs/code/Utopia/Static/MimeTypeLoader.html +427 -427
- data/docs/code/Utopia/Static/MimeTypeLoader/ExpansionError.html +123 -123
- data/docs/code/_index.html +757 -757
- data/docs/code/class_list.html +51 -51
- data/docs/code/css/full_list.css +58 -58
- data/docs/code/css/style.css +496 -499
- data/docs/code/file.README.html +72 -70
- data/docs/code/file_list.html +56 -56
- data/docs/code/frames.html +17 -17
- data/docs/code/index.html +72 -70
- data/docs/code/js/app.js +292 -248
- data/docs/code/js/full_list.js +216 -216
- data/docs/code/js/jquery.js +3 -3
- data/docs/code/method_list.html +3443 -3443
- data/docs/code/top-level-namespace.html +109 -109
- data/docs/index.html +2 -2
- data/docs/wiki.html +2 -2
- data/docs/wiki/edit.html +1 -1
- data/docs/wiki/javascript.html +153 -0
- data/docs/wiki/javascript/index.html +153 -0
- data/documentation/.yarnrc +1 -0
- data/documentation/Gemfile +1 -0
- data/documentation/config/environment.rb +1 -0
- data/documentation/pages/wiki/content.md +1 -1
- data/documentation/pages/wiki/javascript/content.md +75 -0
- data/documentation/pages/wiki/links.yaml +3 -1
- data/lib/utopia/command/site.rb +4 -4
- data/lib/utopia/version.rb +1 -1
- data/setup/site/.yarnrc +1 -0
- data/setup/site/tasks/yarn.rake +32 -0
- data/spec/utopia/command_spec.rb +2 -2
- metadata +8 -9
- data/docs/wiki/bower-integration.html +0 -74
- data/docs/wiki/bower-integration/index.html +0 -74
- data/documentation/.bowerrc +0 -4
- data/documentation/pages/wiki/bower-integration/content.md +0 -25
- data/setup/.bowerrc +0 -3
- data/setup/site/.bowerrc +0 -4
- data/setup/site/tasks/bower.rake +0 -45
data/docs/code/file.README.html
CHANGED
@@ -1,62 +1,62 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="UTF-8">
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<title>
|
7
|
-
File: README
|
8
|
-
|
9
|
-
— Documentation by YARD 0.9.
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
pathId = "README";
|
19
|
-
relpath = '';
|
20
|
-
</script>
|
21
|
-
|
22
|
-
|
23
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
-
|
25
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
-
|
27
|
-
|
28
|
-
</head>
|
29
|
-
<body>
|
30
|
-
<div class="nav_wrap">
|
31
|
-
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
-
<div id="resizer"></div>
|
33
|
-
</div>
|
34
|
-
|
35
|
-
<div id="main" tabindex="-1">
|
36
|
-
<div id="header">
|
37
|
-
<div id="menu">
|
38
|
-
|
39
|
-
<a href="_index.html">Index</a> »
|
40
|
-
<span class="title">File: README</span>
|
41
|
-
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<div id="search">
|
45
|
-
|
46
|
-
<a class="full_list_link" id="class_list_link"
|
47
|
-
href="class_list.html">
|
48
|
-
|
49
|
-
<svg width="24" height="24">
|
50
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
</svg>
|
54
|
-
</a>
|
55
|
-
|
56
|
-
</div>
|
57
|
-
<div class="clear"></div>
|
58
|
-
</div>
|
59
|
-
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.18
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
60
|
<div id="content"><div id='filecontents'><h1 id="utopia-logomaterialsutopiasvg"><img src="materials/utopia.svg" alt="Utopia Logo" /></h1>
|
61
61
|
|
62
62
|
<p>Utopia is a website generation framework which provides a robust set of tools to build highly complex dynamic websites. It uses the filesystem heavily for content and provides functions for interacting with files and directories as structure representing the website.</p>
|
@@ -85,6 +85,8 @@
|
|
85
85
|
|
86
86
|
<h2 id="installation">Installation</h2>
|
87
87
|
|
88
|
+
<p>Make sure you have git, ruby, and bundler installed and set up correctly.</p>
|
89
|
+
|
88
90
|
<p>Install utopia:</p>
|
89
91
|
|
90
92
|
<pre class="code ruby"><code class="ruby">$ gem install utopia
|
@@ -100,7 +102,7 @@ $ rake
|
|
100
102
|
|
101
103
|
<h2 id="usage">Usage</h2>
|
102
104
|
|
103
|
-
<p>There is an excellent documentation wiki included with the source code. Simply clone this repository and <code>rake documentation</code>. This documentation wiki is editable, so feel free to submit a PR with improvements.</p>
|
105
|
+
<p>There is an excellent documentation wiki included with the source code. Simply clone this repository and <code>rake documentation:server</code>. This documentation wiki is editable, so feel free to submit a PR with improvements.</p>
|
104
106
|
|
105
107
|
<h2 id="contributing">Contributing</h2>
|
106
108
|
|
@@ -156,14 +158,14 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
156
158
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
157
159
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
158
160
|
THE SOFTWARE.</p>
|
159
|
-
</div></div>
|
160
|
-
|
161
|
-
<div id="footer">
|
162
|
-
Generated on Sat Mar
|
163
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
164
|
-
0.9.
|
165
|
-
</div>
|
166
|
-
|
167
|
-
</div>
|
168
|
-
</body>
|
161
|
+
</div></div>
|
162
|
+
|
163
|
+
<div id="footer">
|
164
|
+
Generated on Sat Mar 9 12:01:52 2019 by
|
165
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
166
|
+
0.9.18 (ruby-2.6.1).
|
167
|
+
</div>
|
168
|
+
|
169
|
+
</div>
|
170
|
+
</body>
|
169
171
|
</html>
|
data/docs/code/file_list.html
CHANGED
@@ -1,56 +1,56 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
-
<meta charset="utf-8" />
|
6
|
-
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
-
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
-
|
15
|
-
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
-
|
17
|
-
|
18
|
-
<title>File List</title>
|
19
|
-
<base id="base_target" target="_parent" />
|
20
|
-
</head>
|
21
|
-
<body>
|
22
|
-
<div id="content">
|
23
|
-
<div class="fixed_header">
|
24
|
-
<h1 id="full_list_header">File List</h1>
|
25
|
-
<div id="full_list_nav">
|
26
|
-
|
27
|
-
<span><a target="_self" href="class_list.html">
|
28
|
-
Classes
|
29
|
-
</a></span>
|
30
|
-
|
31
|
-
<span><a target="_self" href="method_list.html">
|
32
|
-
Methods
|
33
|
-
</a></span>
|
34
|
-
|
35
|
-
<span><a target="_self" href="file_list.html">
|
36
|
-
Files
|
37
|
-
</a></span>
|
38
|
-
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">Search: <input type="text" /></div>
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<ul id="full_list" class="file">
|
45
|
-
|
46
|
-
|
47
|
-
<li id="object_README" class="odd">
|
48
|
-
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
-
</li>
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
</ul>
|
54
|
-
</div>
|
55
|
-
</body>
|
56
|
-
</html>
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
+
<meta charset="utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<title>File List</title>
|
19
|
+
<base id="base_target" target="_parent" />
|
20
|
+
</head>
|
21
|
+
<body>
|
22
|
+
<div id="content">
|
23
|
+
<div class="fixed_header">
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
25
|
+
<div id="full_list_nav">
|
26
|
+
|
27
|
+
<span><a target="_self" href="class_list.html">
|
28
|
+
Classes
|
29
|
+
</a></span>
|
30
|
+
|
31
|
+
<span><a target="_self" href="method_list.html">
|
32
|
+
Methods
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="file_list.html">
|
36
|
+
Files
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<ul id="full_list" class="file">
|
45
|
+
|
46
|
+
|
47
|
+
<li id="object_README" class="odd">
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
+
</li>
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
</ul>
|
54
|
+
</div>
|
55
|
+
</body>
|
56
|
+
</html>
|
data/docs/code/frames.html
CHANGED
@@ -1,17 +1,17 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="utf-8">
|
5
|
-
<title>Documentation by YARD 0.9.
|
6
|
-
</head>
|
7
|
-
<script type="text/javascript" charset="utf-8">
|
8
|
-
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
-
var name = match ? match[1] : 'index.html';
|
10
|
-
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
-
window.top.location = name;
|
12
|
-
</script>
|
13
|
-
<noscript>
|
14
|
-
<h1>Oops!</h1>
|
15
|
-
<h2>YARD requires JavaScript!</h2>
|
16
|
-
</noscript>
|
17
|
-
</html>
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Documentation by YARD 0.9.18</title>
|
6
|
+
</head>
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
+
var name = match ? match[1] : 'index.html';
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
+
window.top.location = name;
|
12
|
+
</script>
|
13
|
+
<noscript>
|
14
|
+
<h1>Oops!</h1>
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
16
|
+
</noscript>
|
17
|
+
</html>
|
data/docs/code/index.html
CHANGED
@@ -1,62 +1,62 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="UTF-8">
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<title>
|
7
|
-
File: README
|
8
|
-
|
9
|
-
— Documentation by YARD 0.9.
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
pathId = "README";
|
19
|
-
relpath = '';
|
20
|
-
</script>
|
21
|
-
|
22
|
-
|
23
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
-
|
25
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
-
|
27
|
-
|
28
|
-
</head>
|
29
|
-
<body>
|
30
|
-
<div class="nav_wrap">
|
31
|
-
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
|
-
<div id="resizer"></div>
|
33
|
-
</div>
|
34
|
-
|
35
|
-
<div id="main" tabindex="-1">
|
36
|
-
<div id="header">
|
37
|
-
<div id="menu">
|
38
|
-
|
39
|
-
<a href="_index.html">Index</a> »
|
40
|
-
<span class="title">File: README</span>
|
41
|
-
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<div id="search">
|
45
|
-
|
46
|
-
<a class="full_list_link" id="class_list_link"
|
47
|
-
href="class_list.html">
|
48
|
-
|
49
|
-
<svg width="24" height="24">
|
50
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
</svg>
|
54
|
-
</a>
|
55
|
-
|
56
|
-
</div>
|
57
|
-
<div class="clear"></div>
|
58
|
-
</div>
|
59
|
-
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.18
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
60
|
<div id="content"><div id='filecontents'><h1 id="utopia-logomaterialsutopiasvg"><img src="materials/utopia.svg" alt="Utopia Logo" /></h1>
|
61
61
|
|
62
62
|
<p>Utopia is a website generation framework which provides a robust set of tools to build highly complex dynamic websites. It uses the filesystem heavily for content and provides functions for interacting with files and directories as structure representing the website.</p>
|
@@ -85,6 +85,8 @@
|
|
85
85
|
|
86
86
|
<h2 id="installation">Installation</h2>
|
87
87
|
|
88
|
+
<p>Make sure you have git, ruby, and bundler installed and set up correctly.</p>
|
89
|
+
|
88
90
|
<p>Install utopia:</p>
|
89
91
|
|
90
92
|
<pre class="code ruby"><code class="ruby">$ gem install utopia
|
@@ -100,7 +102,7 @@ $ rake
|
|
100
102
|
|
101
103
|
<h2 id="usage">Usage</h2>
|
102
104
|
|
103
|
-
<p>There is an excellent documentation wiki included with the source code. Simply clone this repository and <code>rake documentation</code>. This documentation wiki is editable, so feel free to submit a PR with improvements.</p>
|
105
|
+
<p>There is an excellent documentation wiki included with the source code. Simply clone this repository and <code>rake documentation:server</code>. This documentation wiki is editable, so feel free to submit a PR with improvements.</p>
|
104
106
|
|
105
107
|
<h2 id="contributing">Contributing</h2>
|
106
108
|
|
@@ -156,14 +158,14 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
156
158
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
157
159
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
158
160
|
THE SOFTWARE.</p>
|
159
|
-
</div></div>
|
160
|
-
|
161
|
-
<div id="footer">
|
162
|
-
Generated on Sat Mar
|
163
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
164
|
-
0.9.
|
165
|
-
</div>
|
166
|
-
|
167
|
-
</div>
|
168
|
-
</body>
|
161
|
+
</div></div>
|
162
|
+
|
163
|
+
<div id="footer">
|
164
|
+
Generated on Sat Mar 9 12:01:52 2019 by
|
165
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
166
|
+
0.9.18 (ruby-2.6.1).
|
167
|
+
</div>
|
168
|
+
|
169
|
+
</div>
|
170
|
+
</body>
|
169
171
|
</html>
|