guider 0.0.3 → 0.0.4
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +13 -3
- data/bin/guider +5 -0
- data/guider.gemspec +1 -1
- data/lib/guider/config.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
@@ -12,15 +12,25 @@ Grab it from rubygems:
|
|
12
12
|
|
13
13
|
## Usage
|
14
14
|
|
15
|
-
Just point guider at
|
15
|
+
Just point guider at your guides directory:
|
16
16
|
|
17
|
-
guider path/to/guides
|
17
|
+
guider /path/to/guides
|
18
18
|
|
19
19
|
This will by default output the docs to `out/` directory. Use the
|
20
20
|
`--output` option to specify a different path.
|
21
21
|
|
22
|
+
All files inside the guides directory will get copied over to the
|
23
|
+
output directory. All Markdown files (`*.md`) will be converted to
|
24
|
+
HTML files with the same name (excepth the `README.md` which is turned
|
25
|
+
into `index.html` for backwards compatibility with JSDuck).
|
26
|
+
|
27
|
+
To generate guides index page from the `guides.json` file use the
|
28
|
+
`--index` option:
|
29
|
+
|
30
|
+
guider /path/to/guides --index=/path/to/guides.json
|
31
|
+
|
32
|
+
|
22
33
|
## License
|
23
34
|
|
24
35
|
Guider is free software, licensed under GNU General Public License
|
25
36
|
version 3.
|
26
|
-
|
data/bin/guider
CHANGED
data/guider.gemspec
CHANGED
data/lib/guider/config.rb
CHANGED