doco 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README.textile +22 -1
- metadata +2 -2
data/README.textile
CHANGED
@@ -4,7 +4,28 @@ Is a simple piece of rack middleware[1] which allows me to write stuff in textil
|
|
4
4
|
|
5
5
|
h2. Usage
|
6
6
|
|
7
|
-
|
7
|
+
# Install the gem:
|
8
|
+
<pre><code>gem install doco</code></pre>
|
9
|
+
# Create your file structure, here's an example:
|
10
|
+
<pre><code>dir/
|
11
|
+
|-- config.ru
|
12
|
+
|-- layouts
|
13
|
+
| `-- default.mustache
|
14
|
+
`-- pages
|
15
|
+
`-- index.textile
|
16
|
+
</code></pre>
|
17
|
+
# Add Doco to your @config.ru@:
|
18
|
+
<pre><code>require 'doco'
|
19
|
+
use Rack::Doco
|
20
|
+
</code></pre>
|
21
|
+
# Serve it up using your favourite rack server!
|
22
|
+
|
23
|
+
h2. Middleware Options
|
24
|
+
|
25
|
+
Doco's middleware can have a few options passed to it, these are:
|
26
|
+
<pre><code>:url => '/' # path at which to mount Doco
|
27
|
+
:root => Dir.pwd # path in which to locate the `layouts` and `pages` directories.
|
28
|
+
</code></pre>
|
8
29
|
|
9
30
|
h2. Patches & Feedback
|
10
31
|
|