Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A command-line web server that renders wiki markup files. It's handy when you want a quick preview of your markup.
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
.document
.gitignore
Gemfile
Gemfile.lock
LICENSE.txt
README.rdoc
Rakefile
VERSION
qwiki.gemspec

README.rdoc

qwiki

A command-line web server that renders wiki markup files. It's handy when you want a quick preview of your markup.

Instructions

gem install qwiki
cd a_directory_with_wiki_files
qwiki

Then point your browser to localhost:4567. The markup is reloaded every time you refresh your browser and qwiki doesn't create any temp folder clutter.

Supported markup

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 for details.

Similar projects

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).

If you are documenting Ruby code instead of writing wiki markup then check out Yard.

Copyright

Copyright © 2010 Brian Alexander. See LICENSE.txt for details.

Something went wrong with that request. Please try again.