guider 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/README.md CHANGED
@@ -12,15 +12,25 @@ Grab it from rubygems:
12
12
 
13
13
  ## Usage
14
14
 
15
- Just point guider at the `guides.json` file:
15
+ Just point guider at your guides directory:
16
16
 
17
- guider path/to/guides.json
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
@@ -35,6 +35,11 @@ input_files = OptionParser.new do |opts|
35
35
  puts opts
36
36
  exit
37
37
  end
38
+
39
+ opts.on("--version", "Prints guider version number.") do
40
+ puts "Guider 0.0.4"
41
+ exit
42
+ end
38
43
  end.parse!
39
44
 
40
45
  if input_files.length == 1
@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
2
2
  s.required_rubygems_version = ">= 1.3.5"
3
3
 
4
4
  s.name = 'guider'
5
- s.version = '0.0.3'
5
+ s.version = '0.0.4'
6
6
  s.date = '2013-03-18'
7
7
  s.summary = "Sencha guide generator"
8
8
  s.description = "JSDuck-compatible guides generator"
@@ -34,7 +34,7 @@ module Guider
34
34
 
35
35
  def to_href(guide)
36
36
  if guide['url']
37
- guide['url'].sub(/^guides\//)
37
+ guide['url'].sub(/^guides\//, "")
38
38
  else
39
39
  guide['name']
40
40
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: guider
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
4
+ version: 0.0.4
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors: