qwiki 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +0 -1
- data/Gemfile.lock +0 -2
- data/README.rdoc +20 -14
- data/VERSION +1 -1
- data/qwiki.gemspec +1 -4
- data/test/helper.rb +0 -1
- data/test/test_qwiki.rb +0 -3
- metadata +9 -22
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
data/README.rdoc
CHANGED
@@ -1,19 +1,25 @@
|
|
1
1
|
= qwiki
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
== Contributing to qwiki
|
6
|
-
|
7
|
-
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
|
8
|
-
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
|
9
|
-
* Fork the project
|
10
|
-
* Start a feature/bugfix branch
|
11
|
-
* Commit and push until you are happy with your contribution
|
12
|
-
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
|
13
|
-
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
|
3
|
+
A command-line web server that renders wiki markup files. It's handy when you want a quick preview of your markup.
|
14
4
|
|
15
|
-
==
|
5
|
+
== Instructions
|
6
|
+
|
7
|
+
gem install qwiki
|
8
|
+
cd a_directory_with_wiki_files
|
9
|
+
qwiki
|
10
|
+
|
11
|
+
Then point your browser to http://localhost:4567. The markup is reloaded every time you refresh your browser and qwiki doesn't create any temp folder clutter.
|
12
|
+
|
13
|
+
== Supported markup
|
14
|
+
|
15
|
+
Several different types of markup are supported but you may need to install addition gems. The markup type is detected by filename extension. See {github/markup}[https://github.com/github/markup] for details.
|
16
16
|
|
17
|
-
|
18
|
-
|
17
|
+
== Similar projects
|
18
|
+
|
19
|
+
{Gollum}[https://github.com/github/gollum] (by Github) is a wiki engine powered by Git. Qwiki uses the same rendering engine as Gollum (although Qwiki will {correctly render RDoc in Ruby 1.9}[https://github.com/github/markup/issues#issue/30]).
|
20
|
+
|
21
|
+
If you are documenting Ruby code instead of writing wiki markup then check out {Yard}[http://yardoc.org/].
|
22
|
+
|
23
|
+
== Copyright
|
19
24
|
|
25
|
+
Copyright (c) 2010 Brian Alexander. See LICENSE.txt for details.
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.1
|
data/qwiki.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
Gem::Specification.new do |s|
|
7
7
|
s.name = %q{qwiki}
|
8
|
-
s.version = "1.0.
|
8
|
+
s.version = "1.0.1"
|
9
9
|
|
10
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
11
|
s.authors = ["Brian Alexander"]
|
@@ -52,7 +52,6 @@ Gem::Specification.new do |s|
|
|
52
52
|
s.add_runtime_dependency(%q<haml>, [">= 0"])
|
53
53
|
s.add_runtime_dependency(%q<rdoc>, [">= 0"])
|
54
54
|
s.add_runtime_dependency(%q<sinatra>, [">= 0"])
|
55
|
-
s.add_development_dependency(%q<shoulda>, [">= 0"])
|
56
55
|
s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
|
57
56
|
s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
|
58
57
|
s.add_development_dependency(%q<rcov>, [">= 0"])
|
@@ -61,7 +60,6 @@ Gem::Specification.new do |s|
|
|
61
60
|
s.add_dependency(%q<haml>, [">= 0"])
|
62
61
|
s.add_dependency(%q<rdoc>, [">= 0"])
|
63
62
|
s.add_dependency(%q<sinatra>, [">= 0"])
|
64
|
-
s.add_dependency(%q<shoulda>, [">= 0"])
|
65
63
|
s.add_dependency(%q<bundler>, ["~> 1.0.0"])
|
66
64
|
s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
|
67
65
|
s.add_dependency(%q<rcov>, [">= 0"])
|
@@ -71,7 +69,6 @@ Gem::Specification.new do |s|
|
|
71
69
|
s.add_dependency(%q<haml>, [">= 0"])
|
72
70
|
s.add_dependency(%q<rdoc>, [">= 0"])
|
73
71
|
s.add_dependency(%q<sinatra>, [">= 0"])
|
74
|
-
s.add_dependency(%q<shoulda>, [">= 0"])
|
75
72
|
s.add_dependency(%q<bundler>, ["~> 1.0.0"])
|
76
73
|
s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
|
77
74
|
s.add_dependency(%q<rcov>, [">= 0"])
|
data/test/helper.rb
CHANGED
data/test/test_qwiki.rb
CHANGED
metadata
CHANGED
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
|
|
5
5
|
segments:
|
6
6
|
- 1
|
7
7
|
- 0
|
8
|
-
-
|
9
|
-
version: 1.0.
|
8
|
+
- 1
|
9
|
+
version: 1.0.1
|
10
10
|
platform: ruby
|
11
11
|
authors:
|
12
12
|
- Brian Alexander
|
@@ -69,22 +69,9 @@ dependencies:
|
|
69
69
|
type: :runtime
|
70
70
|
prerelease: false
|
71
71
|
version_requirements: *id004
|
72
|
-
- !ruby/object:Gem::Dependency
|
73
|
-
name: shoulda
|
74
|
-
requirement: &id005 !ruby/object:Gem::Requirement
|
75
|
-
none: false
|
76
|
-
requirements:
|
77
|
-
- - ">="
|
78
|
-
- !ruby/object:Gem::Version
|
79
|
-
segments:
|
80
|
-
- 0
|
81
|
-
version: "0"
|
82
|
-
type: :development
|
83
|
-
prerelease: false
|
84
|
-
version_requirements: *id005
|
85
72
|
- !ruby/object:Gem::Dependency
|
86
73
|
name: bundler
|
87
|
-
requirement: &
|
74
|
+
requirement: &id005 !ruby/object:Gem::Requirement
|
88
75
|
none: false
|
89
76
|
requirements:
|
90
77
|
- - ~>
|
@@ -96,10 +83,10 @@ dependencies:
|
|
96
83
|
version: 1.0.0
|
97
84
|
type: :development
|
98
85
|
prerelease: false
|
99
|
-
version_requirements: *
|
86
|
+
version_requirements: *id005
|
100
87
|
- !ruby/object:Gem::Dependency
|
101
88
|
name: jeweler
|
102
|
-
requirement: &
|
89
|
+
requirement: &id006 !ruby/object:Gem::Requirement
|
103
90
|
none: false
|
104
91
|
requirements:
|
105
92
|
- - ~>
|
@@ -111,10 +98,10 @@ dependencies:
|
|
111
98
|
version: 1.5.1
|
112
99
|
type: :development
|
113
100
|
prerelease: false
|
114
|
-
version_requirements: *
|
101
|
+
version_requirements: *id006
|
115
102
|
- !ruby/object:Gem::Dependency
|
116
103
|
name: rcov
|
117
|
-
requirement: &
|
104
|
+
requirement: &id007 !ruby/object:Gem::Requirement
|
118
105
|
none: false
|
119
106
|
requirements:
|
120
107
|
- - ">="
|
@@ -124,7 +111,7 @@ dependencies:
|
|
124
111
|
version: "0"
|
125
112
|
type: :development
|
126
113
|
prerelease: false
|
127
|
-
version_requirements: *
|
114
|
+
version_requirements: *id007
|
128
115
|
description: A command-line web server that renders wiki markup files. It's handy when you want a quick preview of your markup.
|
129
116
|
email: balexand@gmail.com
|
130
117
|
executables:
|
@@ -162,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
162
149
|
requirements:
|
163
150
|
- - ">="
|
164
151
|
- !ruby/object:Gem::Version
|
165
|
-
hash:
|
152
|
+
hash: 1742416653296031020
|
166
153
|
segments:
|
167
154
|
- 0
|
168
155
|
version: "0"
|